1851 lines
148 KiB
HTML
1851 lines
148 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.modeling_cmd — kittycad v0.7.1 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=19f00094" />
|
|
<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" />
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../../../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<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=a1b19286"></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 class="version">
|
|
v0.7.1
|
|
</div>
|
|
<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.modeling_cmd</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.modeling_cmd</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">List</span><span class="p">,</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.annotation_options</span> <span class="kn">import</span> <span class="n">AnnotationOptions</span>
|
|
<span class="kn">from</span> <span class="nn">..models.annotation_type</span> <span class="kn">import</span> <span class="n">AnnotationType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.camera_drag_interaction_type</span> <span class="kn">import</span> <span class="n">CameraDragInteractionType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.color</span> <span class="kn">import</span> <span class="n">Color</span>
|
|
<span class="kn">from</span> <span class="nn">..models.cut_type</span> <span class="kn">import</span> <span class="n">CutType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.distance_type</span> <span class="kn">import</span> <span class="n">DistanceType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.entity_type</span> <span class="kn">import</span> <span class="n">EntityType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.image_format</span> <span class="kn">import</span> <span class="n">ImageFormat</span>
|
|
<span class="kn">from</span> <span class="nn">..models.import_file</span> <span class="kn">import</span> <span class="n">ImportFile</span>
|
|
<span class="kn">from</span> <span class="nn">..models.input_format</span> <span class="kn">import</span> <span class="n">InputFormat</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.modeling_cmd_id</span> <span class="kn">import</span> <span class="n">ModelingCmdId</span>
|
|
<span class="kn">from</span> <span class="nn">..models.output_format</span> <span class="kn">import</span> <span class="n">OutputFormat</span>
|
|
<span class="kn">from</span> <span class="nn">..models.path_component_constraint_bound</span> <span class="kn">import</span> <span class="n">PathComponentConstraintBound</span>
|
|
<span class="kn">from</span> <span class="nn">..models.path_component_constraint_type</span> <span class="kn">import</span> <span class="n">PathComponentConstraintType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.path_segment</span> <span class="kn">import</span> <span class="n">PathSegment</span>
|
|
<span class="kn">from</span> <span class="nn">..models.perspective_camera_parameters</span> <span class="kn">import</span> <span class="n">PerspectiveCameraParameters</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>
|
|
<span class="kn">from</span> <span class="nn">..models.scene_selection_type</span> <span class="kn">import</span> <span class="n">SceneSelectionType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.scene_tool_type</span> <span class="kn">import</span> <span class="n">SceneToolType</span>
|
|
<span class="kn">from</span> <span class="nn">..models.transform</span> <span class="kn">import</span> <span class="n">Transform</span>
|
|
<span class="kn">from</span> <span class="nn">..models.unit_area</span> <span class="kn">import</span> <span class="n">UnitArea</span>
|
|
<span class="kn">from</span> <span class="nn">..models.unit_density</span> <span class="kn">import</span> <span class="n">UnitDensity</span>
|
|
<span class="kn">from</span> <span class="nn">..models.unit_length</span> <span class="kn">import</span> <span class="n">UnitLength</span>
|
|
<span class="kn">from</span> <span class="nn">..models.unit_mass</span> <span class="kn">import</span> <span class="n">UnitMass</span>
|
|
<span class="kn">from</span> <span class="nn">..models.unit_volume</span> <span class="kn">import</span> <span class="n">UnitVolume</span>
|
|
|
|
|
|
<div class="viewcode-block" id="OptionStartPath">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionStartPath.html#kittycad.models.modeling_cmd.OptionStartPath">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionStartPath</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Start a new path."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"start_path"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"start_path"</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="OptionMovePathPen">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionMovePathPen.html#kittycad.models.modeling_cmd.OptionMovePathPen">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionMovePathPen</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Move the path's \"pen\". If you're in sketch mode, these coordinates are in the local coordinate system, not the world's coordinate system. For example, say you're sketching on the plane {x: (1,0,0), y: (0,1,0), origin: (0, 0, 50)}. In other words, the plane 50 units above the default XY plane. Then, moving the pen to (1, 1, 0) with this command uses local coordinates. So, it would move the pen to (1, 1, 50) in global coordinates."""</span>
|
|
|
|
<span class="n">path</span><span class="p">:</span> <span class="n">ModelingCmdId</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">"move_path_pen"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"move_path_pen"</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="OptionExtendPath">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionExtendPath.html#kittycad.models.modeling_cmd.OptionExtendPath">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionExtendPath</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Extend a path by adding a new segment which starts at the path's \"pen\". If no \"pen\" location has been set before (via `MovePen`), then the pen is at the origin."""</span>
|
|
|
|
<span class="n">path</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="n">segment</span><span class="p">:</span> <span class="n">PathSegment</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"extend_path"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"extend_path"</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="OptionExtrude">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionExtrude.html#kittycad.models.modeling_cmd.OptionExtrude">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionExtrude</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Command for extruding a solid 2d."""</span>
|
|
|
|
<span class="n">distance</span><span class="p">:</span> <span class="n">LengthUnit</span>
|
|
|
|
<span class="n">target</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"extrude"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"extrude"</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="OptionRevolve">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionRevolve.html#kittycad.models.modeling_cmd.OptionRevolve">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionRevolve</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Command for revolving a solid 2d."""</span>
|
|
|
|
<span class="n">angle</span><span class="p">:</span> <span class="n">Angle</span>
|
|
|
|
<span class="n">axis</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">axis_is_2d</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">origin</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">target</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="n">tolerance</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">"revolve"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"revolve"</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="OptionSolid3DShellFace">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DShellFace.html#kittycad.models.modeling_cmd.OptionSolid3DShellFace">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DShellFace</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Command for shelling a solid3d face"""</span>
|
|
|
|
<span class="n">face_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">hollow</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">shell_thickness</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">"solid3d_shell_face"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_shell_face"</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="OptionRevolveAboutEdge">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionRevolveAboutEdge.html#kittycad.models.modeling_cmd.OptionRevolveAboutEdge">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionRevolveAboutEdge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Command for revolving a solid 2d about a brep edge"""</span>
|
|
|
|
<span class="n">angle</span><span class="p">:</span> <span class="n">Angle</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">target</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="n">tolerance</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">"revolve_about_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"revolve_about_edge"</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="OptionLoft">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionLoft.html#kittycad.models.modeling_cmd.OptionLoft">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionLoft</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Command for lofting sections to create a solid"""</span>
|
|
|
|
<span class="n">base_curve_index</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">bez_approximate_rational</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">section_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">tolerance</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">"loft"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"loft"</span>
|
|
|
|
<span class="n">v_degree</span><span class="p">:</span> <span class="nb">int</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="OptionClosePath">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionClosePath.html#kittycad.models.modeling_cmd.OptionClosePath">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionClosePath</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Closes a path, converting it to a 2D solid."""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"close_path"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"close_path"</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="OptionCameraDragStart">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCameraDragStart.html#kittycad.models.modeling_cmd.OptionCameraDragStart">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCameraDragStart</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Camera drag started."""</span>
|
|
|
|
<span class="n">interaction</span><span class="p">:</span> <span class="n">CameraDragInteractionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"camera_drag_start"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"camera_drag_start"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionCameraDragMove">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCameraDragMove.html#kittycad.models.modeling_cmd.OptionCameraDragMove">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCameraDragMove</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Camera drag continued."""</span>
|
|
|
|
<span class="n">interaction</span><span class="p">:</span> <span class="n">CameraDragInteractionType</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"camera_drag_move"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"camera_drag_move"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionCameraDragEnd">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCameraDragEnd.html#kittycad.models.modeling_cmd.OptionCameraDragEnd">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCameraDragEnd</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Camera drag ended"""</span>
|
|
|
|
<span class="n">interaction</span><span class="p">:</span> <span class="n">CameraDragInteractionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"camera_drag_end"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"camera_drag_end"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionDefaultCameraGetSettings">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraGetSettings.html#kittycad.models.modeling_cmd.OptionDefaultCameraGetSettings">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraGetSettings</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets the default camera's camera settings"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_get_settings"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_get_settings"</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="OptionDefaultCameraLookAt">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraLookAt.html#kittycad.models.modeling_cmd.OptionDefaultCameraLookAt">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraLookAt</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Change what the default camera is looking at."""</span>
|
|
|
|
<span class="n">center</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_look_at"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_look_at"</span>
|
|
|
|
<span class="n">up</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">vantage</span><span class="p">:</span> <span class="n">Point3d</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="OptionDefaultCameraPerspectiveSettings">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraPerspectiveSettings.html#kittycad.models.modeling_cmd.OptionDefaultCameraPerspectiveSettings">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraPerspectiveSettings</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Change what the default camera is looking at."""</span>
|
|
|
|
<span class="n">center</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">fov_y</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_perspective_settings"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
|
<span class="s2">"default_camera_perspective_settings"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="n">up</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">vantage</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">z_far</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">z_near</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</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="OptionDefaultCameraZoom">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraZoom.html#kittycad.models.modeling_cmd.OptionDefaultCameraZoom">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraZoom</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Adjust zoom of the default camera."""</span>
|
|
|
|
<span class="n">magnitude</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_zoom"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_zoom"</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="OptionExport">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionExport.html#kittycad.models.modeling_cmd.OptionExport">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionExport</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Export the scene to a file."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">format</span><span class="p">:</span> <span class="n">OutputFormat</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"export"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"export"</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="OptionEntityGetParentId">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityGetParentId.html#kittycad.models.modeling_cmd.OptionEntityGetParentId">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityGetParentId</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What is this entity's parent?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_parent_id"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_parent_id"</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="OptionEntityGetNumChildren">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityGetNumChildren.html#kittycad.models.modeling_cmd.OptionEntityGetNumChildren">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityGetNumChildren</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""How many children does the entity have?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_num_children"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_num_children"</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="OptionEntityGetChildUuid">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityGetChildUuid.html#kittycad.models.modeling_cmd.OptionEntityGetChildUuid">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityGetChildUuid</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What is the UUID of this entity's n-th child?"""</span>
|
|
|
|
<span class="n">child_index</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_child_uuid"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_child_uuid"</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="OptionEntityGetAllChildUuids">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityGetAllChildUuids.html#kittycad.models.modeling_cmd.OptionEntityGetAllChildUuids">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityGetAllChildUuids</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What are all UUIDs of this entity's children?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_all_child_uuids"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_all_child_uuids"</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="OptionEntityGetSketchPaths">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityGetSketchPaths.html#kittycad.models.modeling_cmd.OptionEntityGetSketchPaths">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityGetSketchPaths</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What are all UUIDs of all the paths sketched on top of this entity?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_sketch_paths"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_sketch_paths"</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="OptionEntityGetDistance">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityGetDistance.html#kittycad.models.modeling_cmd.OptionEntityGetDistance">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityGetDistance</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What is the distance between these two entities?"""</span>
|
|
|
|
<span class="n">distance_type</span><span class="p">:</span> <span class="n">DistanceType</span>
|
|
|
|
<span class="n">entity_id1</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">entity_id2</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_distance"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_distance"</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="OptionEntityLinearPatternTransform">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityLinearPatternTransform.html#kittycad.models.modeling_cmd.OptionEntityLinearPatternTransform">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityLinearPatternTransform</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Create a pattern using this entity by specifying the transform for each desired repetition. Transformations are performed in the following order (first applied to last applied): scale, rotate, translate."""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">transform</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Transform</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_linear_pattern_transform"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_linear_pattern_transform"</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="OptionEntityLinearPattern">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityLinearPattern.html#kittycad.models.modeling_cmd.OptionEntityLinearPattern">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityLinearPattern</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Create a linear pattern using this entity."""</span>
|
|
|
|
<span class="n">axis</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">num_repetitions</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">spacing</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">"entity_linear_pattern"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_linear_pattern"</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="OptionEntityCircularPattern">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityCircularPattern.html#kittycad.models.modeling_cmd.OptionEntityCircularPattern">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityCircularPattern</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Create a circular pattern using this entity."""</span>
|
|
|
|
<span class="n">arc_degrees</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">axis</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">center</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">num_repetitions</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">rotate_duplicates</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">"entity_circular_pattern"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_circular_pattern"</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="OptionEntityMakeHelix">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityMakeHelix.html#kittycad.models.modeling_cmd.OptionEntityMakeHelix">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityMakeHelix</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Create a helix using the input cylinder and other specified parameters."""</span>
|
|
|
|
<span class="n">cylinder_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">is_clockwise</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">length</span><span class="p">:</span> <span class="n">LengthUnit</span>
|
|
|
|
<span class="n">revolutions</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">start_angle</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">"entity_make_helix"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_make_helix"</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="OptionEntityMirror">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityMirror.html#kittycad.models.modeling_cmd.OptionEntityMirror">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityMirror</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Mirror the input entities over the specified axis. (Currently only supports sketches)"""</span>
|
|
|
|
<span class="n">axis</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">point</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">"entity_mirror"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_mirror"</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="OptionEntityMirrorAcrossEdge">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityMirrorAcrossEdge.html#kittycad.models.modeling_cmd.OptionEntityMirrorAcrossEdge">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityMirrorAcrossEdge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Mirror the input entities over the specified edge. (Currently only supports sketches)"""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_mirror_across_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_mirror_across_edge"</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="OptionSelectWithPoint">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSelectWithPoint.html#kittycad.models.modeling_cmd.OptionSelectWithPoint">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSelectWithPoint</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Modifies the selection by simulating a \"mouse click\" at the given x,y window coordinate Returns ID of whatever was selected."""</span>
|
|
|
|
<span class="n">selected_at_window</span><span class="p">:</span> <span class="n">Point2d</span>
|
|
|
|
<span class="n">selection_type</span><span class="p">:</span> <span class="n">SceneSelectionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_with_point"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_with_point"</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="OptionSelectAdd">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSelectAdd.html#kittycad.models.modeling_cmd.OptionSelectAdd">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSelectAdd</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Adds one or more entities (by UUID) to the selection."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_add"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_add"</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="OptionSelectRemove">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSelectRemove.html#kittycad.models.modeling_cmd.OptionSelectRemove">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSelectRemove</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Removes one or more entities (by UUID) from the selection."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_remove"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_remove"</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="OptionSceneClearAll">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSceneClearAll.html#kittycad.models.modeling_cmd.OptionSceneClearAll">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSceneClearAll</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Removes all of the Objects in the scene"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"scene_clear_all"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"scene_clear_all"</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="OptionSelectReplace">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSelectReplace.html#kittycad.models.modeling_cmd.OptionSelectReplace">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSelectReplace</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Replaces current selection with these entities (by UUID)."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_replace"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_replace"</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="OptionHighlightSetEntity">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionHighlightSetEntity.html#kittycad.models.modeling_cmd.OptionHighlightSetEntity">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionHighlightSetEntity</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Changes the current highlighted entity to whichever one is at the given window coordinate. If there's no entity at this location, clears the highlight."""</span>
|
|
|
|
<span class="n">selected_at_window</span><span class="p">:</span> <span class="n">Point2d</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"highlight_set_entity"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"highlight_set_entity"</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="OptionHighlightSetEntities">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionHighlightSetEntities.html#kittycad.models.modeling_cmd.OptionHighlightSetEntities">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionHighlightSetEntities</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Changes the current highlighted entity to these entities."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"highlight_set_entities"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"highlight_set_entities"</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="OptionNewAnnotation">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionNewAnnotation.html#kittycad.models.modeling_cmd.OptionNewAnnotation">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionNewAnnotation</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Create a new annotation"""</span>
|
|
|
|
<span class="n">annotation_type</span><span class="p">:</span> <span class="n">AnnotationType</span>
|
|
|
|
<span class="n">clobber</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">options</span><span class="p">:</span> <span class="n">AnnotationOptions</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"new_annotation"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"new_annotation"</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="OptionUpdateAnnotation">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionUpdateAnnotation.html#kittycad.models.modeling_cmd.OptionUpdateAnnotation">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionUpdateAnnotation</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Update an annotation"""</span>
|
|
|
|
<span class="n">annotation_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">options</span><span class="p">:</span> <span class="n">AnnotationOptions</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"update_annotation"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"update_annotation"</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="OptionEdgeLinesVisible">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEdgeLinesVisible.html#kittycad.models.modeling_cmd.OptionEdgeLinesVisible">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEdgeLinesVisible</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Changes visibility of scene-wide edge lines on brep solids"""</span>
|
|
|
|
<span class="n">hidden</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">"edge_lines_visible"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"edge_lines_visible"</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="OptionObjectVisible">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionObjectVisible.html#kittycad.models.modeling_cmd.OptionObjectVisible">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionObjectVisible</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Hide or show an object"""</span>
|
|
|
|
<span class="n">hidden</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"object_visible"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"object_visible"</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="OptionObjectBringToFront">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionObjectBringToFront.html#kittycad.models.modeling_cmd.OptionObjectBringToFront">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionObjectBringToFront</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Bring an object to the front of the scene"""</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"object_bring_to_front"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"object_bring_to_front"</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="OptionObjectSetMaterialParamsPbr">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionObjectSetMaterialParamsPbr.html#kittycad.models.modeling_cmd.OptionObjectSetMaterialParamsPbr">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionObjectSetMaterialParamsPbr</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the material properties of an object"""</span>
|
|
|
|
<span class="n">ambient_occlusion</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">color</span><span class="p">:</span> <span class="n">Color</span>
|
|
|
|
<span class="n">metalness</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">roughness</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"object_set_material_params_pbr"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"object_set_material_params_pbr"</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="OptionGetEntityType">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionGetEntityType.html#kittycad.models.modeling_cmd.OptionGetEntityType">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionGetEntityType</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What type of entity is this?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"get_entity_type"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"get_entity_type"</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="OptionSolid3DGetAllEdgeFaces">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DGetAllEdgeFaces.html#kittycad.models.modeling_cmd.OptionSolid3DGetAllEdgeFaces">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DGetAllEdgeFaces</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets all faces which use the given edge."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_all_edge_faces"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_all_edge_faces"</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="OptionSolid2DAddHole">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid2DAddHole.html#kittycad.models.modeling_cmd.OptionSolid2DAddHole">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid2DAddHole</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Add a hole to a Solid2d object before extruding it."""</span>
|
|
|
|
<span class="n">hole_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid2d_add_hole"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid2d_add_hole"</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="OptionSolid3DGetAllOppositeEdges">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DGetAllOppositeEdges.html#kittycad.models.modeling_cmd.OptionSolid3DGetAllOppositeEdges">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DGetAllOppositeEdges</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets all edges which are opposite the given edge, across all possible faces."""</span>
|
|
|
|
<span class="n">along_vector</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Point3d</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_all_opposite_edges"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_all_opposite_edges"</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="OptionSolid3DGetOppositeEdge">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DGetOppositeEdge.html#kittycad.models.modeling_cmd.OptionSolid3DGetOppositeEdge">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DGetOppositeEdge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets the edge opposite the given edge, along the given face."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_opposite_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_opposite_edge"</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="OptionSolid3DGetNextAdjacentEdge">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DGetNextAdjacentEdge.html#kittycad.models.modeling_cmd.OptionSolid3DGetNextAdjacentEdge">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DGetNextAdjacentEdge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets the next adjacent edge for the given edge, along the given face."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_next_adjacent_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_next_adjacent_edge"</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="OptionSolid3DGetPrevAdjacentEdge">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DGetPrevAdjacentEdge.html#kittycad.models.modeling_cmd.OptionSolid3DGetPrevAdjacentEdge">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DGetPrevAdjacentEdge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets the previous adjacent edge for the given edge, along the given face."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_prev_adjacent_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_prev_adjacent_edge"</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="OptionSolid3DFilletEdge">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DFilletEdge.html#kittycad.models.modeling_cmd.OptionSolid3DFilletEdge">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DFilletEdge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Fillets the given edge with the specified radius."""</span>
|
|
|
|
<span class="n">cut_type</span><span class="p">:</span> <span class="n">CutType</span> <span class="o">=</span> <span class="s2">"fillet"</span> <span class="c1"># type: ignore</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">radius</span><span class="p">:</span> <span class="n">LengthUnit</span>
|
|
|
|
<span class="n">tolerance</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">"solid3d_fillet_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_fillet_edge"</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="OptionFaceIsPlanar">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionFaceIsPlanar.html#kittycad.models.modeling_cmd.OptionFaceIsPlanar">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionFaceIsPlanar</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Determines whether a brep face is planar and returns its surface-local planar axes if so"""</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"face_is_planar"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"face_is_planar"</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="OptionFaceGetPosition">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionFaceGetPosition.html#kittycad.models.modeling_cmd.OptionFaceGetPosition">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionFaceGetPosition</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Determines a position on a brep face evaluated by parameters u,v"""</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"face_get_position"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"face_get_position"</span>
|
|
|
|
<span class="n">uv</span><span class="p">:</span> <span class="n">Point2d</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="OptionFaceGetCenter">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionFaceGetCenter.html#kittycad.models.modeling_cmd.OptionFaceGetCenter">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionFaceGetCenter</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Obtains the surface \"center of mass\" """</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"face_get_center"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"face_get_center"</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="OptionFaceGetGradient">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionFaceGetGradient.html#kittycad.models.modeling_cmd.OptionFaceGetGradient">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionFaceGetGradient</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Determines the gradient (dFdu, dFdv) + normal vector on a brep face evaluated by parameters u,v"""</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"face_get_gradient"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"face_get_gradient"</span>
|
|
|
|
<span class="n">uv</span><span class="p">:</span> <span class="n">Point2d</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="OptionSendObject">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSendObject.html#kittycad.models.modeling_cmd.OptionSendObject">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSendObject</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Send object to front or back."""</span>
|
|
|
|
<span class="n">front</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"send_object"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"send_object"</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="OptionEntitySetOpacity">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntitySetOpacity.html#kittycad.models.modeling_cmd.OptionEntitySetOpacity">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntitySetOpacity</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set opacity of the entity."""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">opacity</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_set_opacity"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_set_opacity"</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="OptionEntityFade">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEntityFade.html#kittycad.models.modeling_cmd.OptionEntityFade">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEntityFade</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Fade entity in or out."""</span>
|
|
|
|
<span class="n">duration_seconds</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.4000000059604645</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">fade_in</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">"entity_fade"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_fade"</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="OptionMakePlane">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionMakePlane.html#kittycad.models.modeling_cmd.OptionMakePlane">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionMakePlane</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Make a new plane"""</span>
|
|
|
|
<span class="n">clobber</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">hide</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">origin</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">size</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">"make_plane"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"make_plane"</span>
|
|
|
|
<span class="n">x_axis</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">y_axis</span><span class="p">:</span> <span class="n">Point3d</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="OptionPlaneSetColor">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPlaneSetColor.html#kittycad.models.modeling_cmd.OptionPlaneSetColor">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPlaneSetColor</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the color of a plane."""</span>
|
|
|
|
<span class="n">color</span><span class="p">:</span> <span class="n">Color</span>
|
|
|
|
<span class="n">plane_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"plane_set_color"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"plane_set_color"</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="OptionSetTool">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetTool.html#kittycad.models.modeling_cmd.OptionSetTool">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetTool</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the current tool."""</span>
|
|
|
|
<span class="n">tool</span><span class="p">:</span> <span class="n">SceneToolType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_tool"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_tool"</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="OptionMouseMove">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionMouseMove.html#kittycad.models.modeling_cmd.OptionMouseMove">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionMouseMove</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Send a mouse move event"""</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"mouse_move"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"mouse_move"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionMouseClick">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionMouseClick.html#kittycad.models.modeling_cmd.OptionMouseClick">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionMouseClick</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Send a mouse click event Updates modified/selected entities."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"mouse_click"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"mouse_click"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionSketchModeDisable">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSketchModeDisable.html#kittycad.models.modeling_cmd.OptionSketchModeDisable">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSketchModeDisable</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Disable sketch mode. If you are sketching on a face, be sure to not disable sketch mode until you have extruded. Otherwise, your object will not be fused with the face."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"sketch_mode_disable"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"sketch_mode_disable"</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="OptionGetSketchModePlane">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionGetSketchModePlane.html#kittycad.models.modeling_cmd.OptionGetSketchModePlane">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionGetSketchModePlane</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the plane for sketch mode."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"get_sketch_mode_plane"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"get_sketch_mode_plane"</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="OptionCurveSetConstraint">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCurveSetConstraint.html#kittycad.models.modeling_cmd.OptionCurveSetConstraint">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCurveSetConstraint</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the plane for sketch mode."""</span>
|
|
|
|
<span class="n">constraint_bound</span><span class="p">:</span> <span class="n">PathComponentConstraintBound</span>
|
|
|
|
<span class="n">constraint_type</span><span class="p">:</span> <span class="n">PathComponentConstraintType</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_set_constraint"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_set_constraint"</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="OptionEnableSketchMode">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEnableSketchMode.html#kittycad.models.modeling_cmd.OptionEnableSketchMode">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEnableSketchMode</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Sketch on some entity (e.g. a plane, a face)."""</span>
|
|
|
|
<span class="n">adjust_camera</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">animated</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">ortho</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">planar_normal</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Point3d</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"enable_sketch_mode"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"enable_sketch_mode"</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="OptionEnableDryRun">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionEnableDryRun.html#kittycad.models.modeling_cmd.OptionEnableDryRun">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionEnableDryRun</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Sets whether or not changes to the scene or its objects will be done as a \"dry run\" In a dry run, successful commands won't actually change the model. This is useful for catching errors before actually making the change."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"enable_dry_run"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"enable_dry_run"</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="OptionDisableDryRun">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDisableDryRun.html#kittycad.models.modeling_cmd.OptionDisableDryRun">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDisableDryRun</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Sets whether or not changes to the scene or its objects will be done as a \"dry run\" In a dry run, successful commands won't actually change the model. This is useful for catching errors before actually making the change."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"disable_dry_run"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"disable_dry_run"</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="OptionSetBackgroundColor">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetBackgroundColor.html#kittycad.models.modeling_cmd.OptionSetBackgroundColor">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetBackgroundColor</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the background color of the scene."""</span>
|
|
|
|
<span class="n">color</span><span class="p">:</span> <span class="n">Color</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_background_color"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_background_color"</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="OptionSetCurrentToolProperties">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetCurrentToolProperties.html#kittycad.models.modeling_cmd.OptionSetCurrentToolProperties">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetCurrentToolProperties</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the properties of the tool lines for the scene."""</span>
|
|
|
|
<span class="n">color</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Color</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_current_tool_properties"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_current_tool_properties"</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="OptionSetDefaultSystemProperties">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetDefaultSystemProperties.html#kittycad.models.modeling_cmd.OptionSetDefaultSystemProperties">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetDefaultSystemProperties</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the default system properties used when a specific property isn't set."""</span>
|
|
|
|
<span class="n">color</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Color</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_default_system_properties"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_default_system_properties"</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="OptionCurveGetType">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCurveGetType.html#kittycad.models.modeling_cmd.OptionCurveGetType">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCurveGetType</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get type of the given curve."""</span>
|
|
|
|
<span class="n">curve_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_get_type"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_get_type"</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="OptionCurveGetControlPoints">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCurveGetControlPoints.html#kittycad.models.modeling_cmd.OptionCurveGetControlPoints">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCurveGetControlPoints</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get control points of the given curve."""</span>
|
|
|
|
<span class="n">curve_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_get_control_points"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_get_control_points"</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="OptionTakeSnapshot">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionTakeSnapshot.html#kittycad.models.modeling_cmd.OptionTakeSnapshot">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionTakeSnapshot</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Take a snapshot of the current view."""</span>
|
|
|
|
<span class="nb">format</span><span class="p">:</span> <span class="n">ImageFormat</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"take_snapshot"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"take_snapshot"</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="OptionMakeAxesGizmo">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionMakeAxesGizmo.html#kittycad.models.modeling_cmd.OptionMakeAxesGizmo">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionMakeAxesGizmo</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Add a gizmo showing the axes."""</span>
|
|
|
|
<span class="n">clobber</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">gizmo_mode</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">"make_axes_gizmo"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"make_axes_gizmo"</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="OptionPathGetInfo">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPathGetInfo.html#kittycad.models.modeling_cmd.OptionPathGetInfo">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPathGetInfo</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Query the given path."""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_info"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_info"</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="OptionPathGetCurveUuidsForVertices">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPathGetCurveUuidsForVertices.html#kittycad.models.modeling_cmd.OptionPathGetCurveUuidsForVertices">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPathGetCurveUuidsForVertices</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Obtain curve ids for vertex ids"""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_curve_uuids_for_vertices"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
|
<span class="s2">"path_get_curve_uuids_for_vertices"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="n">vertex_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</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="OptionPathGetCurveUuid">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPathGetCurveUuid.html#kittycad.models.modeling_cmd.OptionPathGetCurveUuid">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPathGetCurveUuid</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Obtain curve id by index"""</span>
|
|
|
|
<span class="n">index</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_curve_uuid"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_curve_uuid"</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="OptionPathGetVertexUuids">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPathGetVertexUuids.html#kittycad.models.modeling_cmd.OptionPathGetVertexUuids">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPathGetVertexUuids</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Obtain vertex ids for a path"""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_vertex_uuids"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_vertex_uuids"</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="OptionPathGetSketchTargetUuid">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPathGetSketchTargetUuid.html#kittycad.models.modeling_cmd.OptionPathGetSketchTargetUuid">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPathGetSketchTargetUuid</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Obtain the sketch target id (if the path was drawn in sketchmode) for a path"""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_sketch_target_uuid"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_sketch_target_uuid"</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="OptionHandleMouseDragStart">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionHandleMouseDragStart.html#kittycad.models.modeling_cmd.OptionHandleMouseDragStart">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionHandleMouseDragStart</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Start dragging the mouse."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handle_mouse_drag_start"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handle_mouse_drag_start"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionHandleMouseDragMove">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionHandleMouseDragMove.html#kittycad.models.modeling_cmd.OptionHandleMouseDragMove">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionHandleMouseDragMove</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Continue dragging the mouse."""</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handle_mouse_drag_move"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handle_mouse_drag_move"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionHandleMouseDragEnd">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionHandleMouseDragEnd.html#kittycad.models.modeling_cmd.OptionHandleMouseDragEnd">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionHandleMouseDragEnd</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Stop dragging the mouse."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handle_mouse_drag_end"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handle_mouse_drag_end"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionRemoveSceneObjects">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionRemoveSceneObjects.html#kittycad.models.modeling_cmd.OptionRemoveSceneObjects">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionRemoveSceneObjects</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Remove scene objects."""</span>
|
|
|
|
<span class="n">object_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"remove_scene_objects"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"remove_scene_objects"</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="OptionPlaneIntersectAndProject">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionPlaneIntersectAndProject.html#kittycad.models.modeling_cmd.OptionPlaneIntersectAndProject">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionPlaneIntersectAndProject</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Utility method. Performs both a ray cast and projection to plane-local coordinates. Returns the plane coordinates for the given window coordinates."""</span>
|
|
|
|
<span class="n">plane_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"plane_intersect_and_project"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"plane_intersect_and_project"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</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="OptionCurveGetEndPoints">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCurveGetEndPoints.html#kittycad.models.modeling_cmd.OptionCurveGetEndPoints">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCurveGetEndPoints</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Find the start and end of a curve."""</span>
|
|
|
|
<span class="n">curve_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_get_end_points"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_get_end_points"</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="OptionReconfigureStream">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionReconfigureStream.html#kittycad.models.modeling_cmd.OptionReconfigureStream">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionReconfigureStream</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Reconfigure the stream."""</span>
|
|
|
|
<span class="n">fps</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">height</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"reconfigure_stream"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"reconfigure_stream"</span>
|
|
|
|
<span class="n">width</span><span class="p">:</span> <span class="nb">int</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="OptionImportFiles">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionImportFiles.html#kittycad.models.modeling_cmd.OptionImportFiles">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionImportFiles</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Import files to the current model."""</span>
|
|
|
|
<span class="n">files</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">ImportFile</span><span class="p">]</span>
|
|
|
|
<span class="nb">format</span><span class="p">:</span> <span class="n">InputFormat</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"import_files"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"import_files"</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="OptionSetSceneUnits">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetSceneUnits.html#kittycad.models.modeling_cmd.OptionSetSceneUnits">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetSceneUnits</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Set the units of the scene. For all following commands, the units will be interpreted as the given units."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_scene_units"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_scene_units"</span>
|
|
|
|
<span class="n">unit</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="OptionMass">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionMass.html#kittycad.models.modeling_cmd.OptionMass">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionMass</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the mass of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"mass"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"mass"</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="OptionDensity">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDensity.html#kittycad.models.modeling_cmd.OptionDensity">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDensity</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the density of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"density"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"density"</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="OptionVolume">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionVolume.html#kittycad.models.modeling_cmd.OptionVolume">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionVolume</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the volume of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"volume"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"volume"</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="OptionCenterOfMass">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionCenterOfMass.html#kittycad.models.modeling_cmd.OptionCenterOfMass">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionCenterOfMass</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the center of mass of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"center_of_mass"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"center_of_mass"</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="OptionSurfaceArea">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSurfaceArea.html#kittycad.models.modeling_cmd.OptionSurfaceArea">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSurfaceArea</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the surface area of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"surface_area"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"surface_area"</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="OptionDefaultCameraFocusOn">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraFocusOn.html#kittycad.models.modeling_cmd.OptionDefaultCameraFocusOn">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraFocusOn</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Focus the default camera upon an object in the scene."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_focus_on"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_focus_on"</span>
|
|
|
|
<span class="n">uuid</span><span class="p">:</span> <span class="nb">str</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="OptionSetSelectionType">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetSelectionType.html#kittycad.models.modeling_cmd.OptionSetSelectionType">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetSelectionType</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""When you select some entity with the current tool, what should happen to the entity?"""</span>
|
|
|
|
<span class="n">selection_type</span><span class="p">:</span> <span class="n">SceneSelectionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_selection_type"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_selection_type"</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="OptionSetSelectionFilter">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSetSelectionFilter.html#kittycad.models.modeling_cmd.OptionSetSelectionFilter">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSetSelectionFilter</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""What kind of entities can be selected?"""</span>
|
|
|
|
<span class="nb">filter</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">EntityType</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_selection_filter"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_selection_filter"</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="OptionDefaultCameraSetOrthographic">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraSetOrthographic.html#kittycad.models.modeling_cmd.OptionDefaultCameraSetOrthographic">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraSetOrthographic</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Use orthographic projection."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_set_orthographic"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_set_orthographic"</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="OptionDefaultCameraSetPerspective">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraSetPerspective.html#kittycad.models.modeling_cmd.OptionDefaultCameraSetPerspective">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraSetPerspective</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Use perspective projection."""</span>
|
|
|
|
<span class="n">parameters</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">PerspectiveCameraParameters</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_set_perspective"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_set_perspective"</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="OptionDefaultCameraCenterToSelection">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionDefaultCameraCenterToSelection.html#kittycad.models.modeling_cmd.OptionDefaultCameraCenterToSelection">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionDefaultCameraCenterToSelection</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Updates the camera to center to the center of the current selection (or the origin if nothing is selected)"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_center_to_selection"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
|
|
<span class="s2">"default_camera_center_to_selection"</span>
|
|
<span class="p">)</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="OptionZoomToFit">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionZoomToFit.html#kittycad.models.modeling_cmd.OptionZoomToFit">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionZoomToFit</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Fit the view to the specified object(s)."""</span>
|
|
|
|
<span class="n">animated</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="n">object_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
|
|
<span class="n">padding</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"zoom_to_fit"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"zoom_to_fit"</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="OptionViewIsometric">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionViewIsometric.html#kittycad.models.modeling_cmd.OptionViewIsometric">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionViewIsometric</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Fit the view to the scene with an isometric view."""</span>
|
|
|
|
<span class="n">padding</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.0</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"view_isometric"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"view_isometric"</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="OptionSolid3DGetExtrusionFaceInfo">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSolid3DGetExtrusionFaceInfo.html#kittycad.models.modeling_cmd.OptionSolid3DGetExtrusionFaceInfo">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSolid3DGetExtrusionFaceInfo</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get a concise description of all of an extrusion's faces."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_extrusion_face_info"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_extrusion_face_info"</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="OptionSelectClear">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSelectClear.html#kittycad.models.modeling_cmd.OptionSelectClear">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSelectClear</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Clear the selection"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_clear"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_clear"</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="OptionSelectGet">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionSelectGet.html#kittycad.models.modeling_cmd.OptionSelectGet">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionSelectGet</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Find all IDs of selected entities"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_get"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_get"</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="OptionGetNumObjects">
|
|
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.OptionGetNumObjects.html#kittycad.models.modeling_cmd.OptionGetNumObjects">[docs]</a>
|
|
<span class="k">class</span> <span class="nc">OptionGetNumObjects</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Get the number of objects in the scene"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"get_num_objects"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"get_num_objects"</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">ModelingCmd</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">OptionStartPath</span><span class="p">,</span>
|
|
<span class="n">OptionMovePathPen</span><span class="p">,</span>
|
|
<span class="n">OptionExtendPath</span><span class="p">,</span>
|
|
<span class="n">OptionExtrude</span><span class="p">,</span>
|
|
<span class="n">OptionRevolve</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DShellFace</span><span class="p">,</span>
|
|
<span class="n">OptionRevolveAboutEdge</span><span class="p">,</span>
|
|
<span class="n">OptionLoft</span><span class="p">,</span>
|
|
<span class="n">OptionClosePath</span><span class="p">,</span>
|
|
<span class="n">OptionCameraDragStart</span><span class="p">,</span>
|
|
<span class="n">OptionCameraDragMove</span><span class="p">,</span>
|
|
<span class="n">OptionCameraDragEnd</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraGetSettings</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraLookAt</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraPerspectiveSettings</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraZoom</span><span class="p">,</span>
|
|
<span class="n">OptionExport</span><span class="p">,</span>
|
|
<span class="n">OptionEntityGetParentId</span><span class="p">,</span>
|
|
<span class="n">OptionEntityGetNumChildren</span><span class="p">,</span>
|
|
<span class="n">OptionEntityGetChildUuid</span><span class="p">,</span>
|
|
<span class="n">OptionEntityGetAllChildUuids</span><span class="p">,</span>
|
|
<span class="n">OptionEntityGetSketchPaths</span><span class="p">,</span>
|
|
<span class="n">OptionEntityGetDistance</span><span class="p">,</span>
|
|
<span class="n">OptionEntityLinearPatternTransform</span><span class="p">,</span>
|
|
<span class="n">OptionEntityLinearPattern</span><span class="p">,</span>
|
|
<span class="n">OptionEntityCircularPattern</span><span class="p">,</span>
|
|
<span class="n">OptionEntityMakeHelix</span><span class="p">,</span>
|
|
<span class="n">OptionEntityMirror</span><span class="p">,</span>
|
|
<span class="n">OptionEntityMirrorAcrossEdge</span><span class="p">,</span>
|
|
<span class="n">OptionSelectWithPoint</span><span class="p">,</span>
|
|
<span class="n">OptionSelectAdd</span><span class="p">,</span>
|
|
<span class="n">OptionSelectRemove</span><span class="p">,</span>
|
|
<span class="n">OptionSceneClearAll</span><span class="p">,</span>
|
|
<span class="n">OptionSelectReplace</span><span class="p">,</span>
|
|
<span class="n">OptionHighlightSetEntity</span><span class="p">,</span>
|
|
<span class="n">OptionHighlightSetEntities</span><span class="p">,</span>
|
|
<span class="n">OptionNewAnnotation</span><span class="p">,</span>
|
|
<span class="n">OptionUpdateAnnotation</span><span class="p">,</span>
|
|
<span class="n">OptionEdgeLinesVisible</span><span class="p">,</span>
|
|
<span class="n">OptionObjectVisible</span><span class="p">,</span>
|
|
<span class="n">OptionObjectBringToFront</span><span class="p">,</span>
|
|
<span class="n">OptionObjectSetMaterialParamsPbr</span><span class="p">,</span>
|
|
<span class="n">OptionGetEntityType</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DGetAllEdgeFaces</span><span class="p">,</span>
|
|
<span class="n">OptionSolid2DAddHole</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DGetAllOppositeEdges</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DGetOppositeEdge</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DGetNextAdjacentEdge</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DGetPrevAdjacentEdge</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DFilletEdge</span><span class="p">,</span>
|
|
<span class="n">OptionFaceIsPlanar</span><span class="p">,</span>
|
|
<span class="n">OptionFaceGetPosition</span><span class="p">,</span>
|
|
<span class="n">OptionFaceGetCenter</span><span class="p">,</span>
|
|
<span class="n">OptionFaceGetGradient</span><span class="p">,</span>
|
|
<span class="n">OptionSendObject</span><span class="p">,</span>
|
|
<span class="n">OptionEntitySetOpacity</span><span class="p">,</span>
|
|
<span class="n">OptionEntityFade</span><span class="p">,</span>
|
|
<span class="n">OptionMakePlane</span><span class="p">,</span>
|
|
<span class="n">OptionPlaneSetColor</span><span class="p">,</span>
|
|
<span class="n">OptionSetTool</span><span class="p">,</span>
|
|
<span class="n">OptionMouseMove</span><span class="p">,</span>
|
|
<span class="n">OptionMouseClick</span><span class="p">,</span>
|
|
<span class="n">OptionSketchModeDisable</span><span class="p">,</span>
|
|
<span class="n">OptionGetSketchModePlane</span><span class="p">,</span>
|
|
<span class="n">OptionCurveSetConstraint</span><span class="p">,</span>
|
|
<span class="n">OptionEnableSketchMode</span><span class="p">,</span>
|
|
<span class="n">OptionEnableDryRun</span><span class="p">,</span>
|
|
<span class="n">OptionDisableDryRun</span><span class="p">,</span>
|
|
<span class="n">OptionSetBackgroundColor</span><span class="p">,</span>
|
|
<span class="n">OptionSetCurrentToolProperties</span><span class="p">,</span>
|
|
<span class="n">OptionSetDefaultSystemProperties</span><span class="p">,</span>
|
|
<span class="n">OptionCurveGetType</span><span class="p">,</span>
|
|
<span class="n">OptionCurveGetControlPoints</span><span class="p">,</span>
|
|
<span class="n">OptionTakeSnapshot</span><span class="p">,</span>
|
|
<span class="n">OptionMakeAxesGizmo</span><span class="p">,</span>
|
|
<span class="n">OptionPathGetInfo</span><span class="p">,</span>
|
|
<span class="n">OptionPathGetCurveUuidsForVertices</span><span class="p">,</span>
|
|
<span class="n">OptionPathGetCurveUuid</span><span class="p">,</span>
|
|
<span class="n">OptionPathGetVertexUuids</span><span class="p">,</span>
|
|
<span class="n">OptionPathGetSketchTargetUuid</span><span class="p">,</span>
|
|
<span class="n">OptionHandleMouseDragStart</span><span class="p">,</span>
|
|
<span class="n">OptionHandleMouseDragMove</span><span class="p">,</span>
|
|
<span class="n">OptionHandleMouseDragEnd</span><span class="p">,</span>
|
|
<span class="n">OptionRemoveSceneObjects</span><span class="p">,</span>
|
|
<span class="n">OptionPlaneIntersectAndProject</span><span class="p">,</span>
|
|
<span class="n">OptionCurveGetEndPoints</span><span class="p">,</span>
|
|
<span class="n">OptionReconfigureStream</span><span class="p">,</span>
|
|
<span class="n">OptionImportFiles</span><span class="p">,</span>
|
|
<span class="n">OptionSetSceneUnits</span><span class="p">,</span>
|
|
<span class="n">OptionMass</span><span class="p">,</span>
|
|
<span class="n">OptionDensity</span><span class="p">,</span>
|
|
<span class="n">OptionVolume</span><span class="p">,</span>
|
|
<span class="n">OptionCenterOfMass</span><span class="p">,</span>
|
|
<span class="n">OptionSurfaceArea</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraFocusOn</span><span class="p">,</span>
|
|
<span class="n">OptionSetSelectionType</span><span class="p">,</span>
|
|
<span class="n">OptionSetSelectionFilter</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraSetOrthographic</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraSetPerspective</span><span class="p">,</span>
|
|
<span class="n">OptionDefaultCameraCenterToSelection</span><span class="p">,</span>
|
|
<span class="n">OptionZoomToFit</span><span class="p">,</span>
|
|
<span class="n">OptionViewIsometric</span><span class="p">,</span>
|
|
<span class="n">OptionSolid3DGetExtrusionFaceInfo</span><span class="p">,</span>
|
|
<span class="n">OptionSelectClear</span><span class="p">,</span>
|
|
<span class="n">OptionSelectGet</span><span class="p">,</span>
|
|
<span class="n">OptionGetNumObjects</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> |