ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
286264f8989647f9ca13931a2dacf20f4b54bb06
kittycad.py/docs/html/_modules/kittycad/models/modeling_cmd.html
github-actions[bot] 286264f898 I HAVE GENERATED YOUR NEW DOCS!
2024-08-23 20:56:42 +00:00

1813 lines
142 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.models.modeling_cmd &mdash; kittycad v0.6.20 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/autoclasstoc.css" type="text/css" />
<!--[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=c0d2930c"></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.6.20
</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.linear_transform</span> <span class="kn">import</span> <span class="n">LinearTransform</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.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="start_path">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.start_path.html#kittycad.models.modeling_cmd.start_path">[docs]</a>
<span class="k">class</span> <span class="nc">start_path</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Start a new path.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;start_path&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;start_path&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="move_path_pen">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.move_path_pen.html#kittycad.models.modeling_cmd.move_path_pen">[docs]</a>
<span class="k">class</span> <span class="nc">move_path_pen</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Move the path&#39;s \&quot;pen\&quot;.&quot;&quot;&quot;</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">&quot;move_path_pen&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;move_path_pen&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="extend_path">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.extend_path.html#kittycad.models.modeling_cmd.extend_path">[docs]</a>
<span class="k">class</span> <span class="nc">extend_path</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Extend a path by adding a new segment which starts at the path&#39;s \&quot;pen\&quot;. If no \&quot;pen\&quot; location has been set before (via `MovePen`), then the pen is at the origin.&quot;&quot;&quot;</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">&quot;extend_path&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;extend_path&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="extrude">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.extrude.html#kittycad.models.modeling_cmd.extrude">[docs]</a>
<span class="k">class</span> <span class="nc">extrude</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Command for extruding a solid 2d.&quot;&quot;&quot;</span>
<span class="n">cap</span><span class="p">:</span> <span class="nb">bool</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">&quot;extrude&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;extrude&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="revolve">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.revolve.html#kittycad.models.modeling_cmd.revolve">[docs]</a>
<span class="k">class</span> <span class="nc">revolve</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Command for revolving a solid 2d.&quot;&quot;&quot;</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">&quot;revolve&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;revolve&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_shell_face">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_shell_face.html#kittycad.models.modeling_cmd.solid3d_shell_face">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_shell_face</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Command for revolving a solid 2d.&quot;&quot;&quot;</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">&quot;solid3d_shell_face&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_shell_face&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="revolve_about_edge">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.revolve_about_edge.html#kittycad.models.modeling_cmd.revolve_about_edge">[docs]</a>
<span class="k">class</span> <span class="nc">revolve_about_edge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Command for revolving a solid 2d about a brep edge&quot;&quot;&quot;</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">&quot;revolve_about_edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;revolve_about_edge&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="close_path">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.close_path.html#kittycad.models.modeling_cmd.close_path">[docs]</a>
<span class="k">class</span> <span class="nc">close_path</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Closes a path, converting it to a 2D solid.&quot;&quot;&quot;</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">&quot;close_path&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;close_path&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="camera_drag_start">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.camera_drag_start.html#kittycad.models.modeling_cmd.camera_drag_start">[docs]</a>
<span class="k">class</span> <span class="nc">camera_drag_start</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Camera drag started.&quot;&quot;&quot;</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">&quot;camera_drag_start&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;camera_drag_start&quot;</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="camera_drag_move">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.camera_drag_move.html#kittycad.models.modeling_cmd.camera_drag_move">[docs]</a>
<span class="k">class</span> <span class="nc">camera_drag_move</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Camera drag continued.&quot;&quot;&quot;</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">&quot;camera_drag_move&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;camera_drag_move&quot;</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="camera_drag_end">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.camera_drag_end.html#kittycad.models.modeling_cmd.camera_drag_end">[docs]</a>
<span class="k">class</span> <span class="nc">camera_drag_end</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Camera drag ended&quot;&quot;&quot;</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">&quot;camera_drag_end&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;camera_drag_end&quot;</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="default_camera_get_settings">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_get_settings.html#kittycad.models.modeling_cmd.default_camera_get_settings">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_get_settings</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets the default camera&#39;s camera settings&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;default_camera_get_settings&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default_camera_get_settings&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="default_camera_look_at">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_look_at.html#kittycad.models.modeling_cmd.default_camera_look_at">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_look_at</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Change what the default camera is looking at.&quot;&quot;&quot;</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">&quot;default_camera_look_at&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default_camera_look_at&quot;</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="default_camera_perspective_settings">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_perspective_settings.html#kittycad.models.modeling_cmd.default_camera_perspective_settings">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_perspective_settings</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Change what the default camera is looking at.&quot;&quot;&quot;</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">&quot;default_camera_perspective_settings&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">&quot;default_camera_perspective_settings&quot;</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="default_camera_zoom">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_zoom.html#kittycad.models.modeling_cmd.default_camera_zoom">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_zoom</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adjust zoom of the default camera.&quot;&quot;&quot;</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">&quot;default_camera_zoom&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default_camera_zoom&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="export">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.export.html#kittycad.models.modeling_cmd.export">[docs]</a>
<span class="k">class</span> <span class="nc">export</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Export the scene to a file.&quot;&quot;&quot;</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">&quot;export&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;export&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_get_parent_id">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_get_parent_id.html#kittycad.models.modeling_cmd.entity_get_parent_id">[docs]</a>
<span class="k">class</span> <span class="nc">entity_get_parent_id</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What is this entity&#39;s parent?&quot;&quot;&quot;</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">&quot;entity_get_parent_id&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_get_parent_id&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_get_num_children">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_get_num_children.html#kittycad.models.modeling_cmd.entity_get_num_children">[docs]</a>
<span class="k">class</span> <span class="nc">entity_get_num_children</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;How many children does the entity have?&quot;&quot;&quot;</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">&quot;entity_get_num_children&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_get_num_children&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_get_child_uuid">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_get_child_uuid.html#kittycad.models.modeling_cmd.entity_get_child_uuid">[docs]</a>
<span class="k">class</span> <span class="nc">entity_get_child_uuid</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What is the UUID of this entity&#39;s n-th child?&quot;&quot;&quot;</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">&quot;entity_get_child_uuid&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_get_child_uuid&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_get_all_child_uuids">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_get_all_child_uuids.html#kittycad.models.modeling_cmd.entity_get_all_child_uuids">[docs]</a>
<span class="k">class</span> <span class="nc">entity_get_all_child_uuids</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What are all UUIDs of this entity&#39;s children?&quot;&quot;&quot;</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">&quot;entity_get_all_child_uuids&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_get_all_child_uuids&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_get_sketch_paths">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_get_sketch_paths.html#kittycad.models.modeling_cmd.entity_get_sketch_paths">[docs]</a>
<span class="k">class</span> <span class="nc">entity_get_sketch_paths</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What are all UUIDs of all the paths sketched on top of this entity?&quot;&quot;&quot;</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">&quot;entity_get_sketch_paths&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_get_sketch_paths&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_get_distance">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_get_distance.html#kittycad.models.modeling_cmd.entity_get_distance">[docs]</a>
<span class="k">class</span> <span class="nc">entity_get_distance</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What is the distance between these two entities?&quot;&quot;&quot;</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">&quot;entity_get_distance&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_get_distance&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_linear_pattern_transform">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_linear_pattern_transform.html#kittycad.models.modeling_cmd.entity_linear_pattern_transform">[docs]</a>
<span class="k">class</span> <span class="nc">entity_linear_pattern_transform</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a pattern using this entity by specifying the transform for each desired repetition.&quot;&quot;&quot;</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">LinearTransform</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">&quot;entity_linear_pattern_transform&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_linear_pattern_transform&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_linear_pattern">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_linear_pattern.html#kittycad.models.modeling_cmd.entity_linear_pattern">[docs]</a>
<span class="k">class</span> <span class="nc">entity_linear_pattern</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a linear pattern using this entity.&quot;&quot;&quot;</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">&quot;entity_linear_pattern&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_linear_pattern&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_circular_pattern">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_circular_pattern.html#kittycad.models.modeling_cmd.entity_circular_pattern">[docs]</a>
<span class="k">class</span> <span class="nc">entity_circular_pattern</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a circular pattern using this entity.&quot;&quot;&quot;</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">&quot;entity_circular_pattern&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_circular_pattern&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_make_helix">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_make_helix.html#kittycad.models.modeling_cmd.entity_make_helix">[docs]</a>
<span class="k">class</span> <span class="nc">entity_make_helix</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a helix using the input cylinder and other specified parameters.&quot;&quot;&quot;</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">&quot;entity_make_helix&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_make_helix&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_mirror">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_mirror.html#kittycad.models.modeling_cmd.entity_mirror">[docs]</a>
<span class="k">class</span> <span class="nc">entity_mirror</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Mirror the input entities over the specified axis. (Currently only supports sketches)&quot;&quot;&quot;</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">&quot;entity_mirror&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_mirror&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_mirror_across_edge">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_mirror_across_edge.html#kittycad.models.modeling_cmd.entity_mirror_across_edge">[docs]</a>
<span class="k">class</span> <span class="nc">entity_mirror_across_edge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Mirror the input entities over the specified edge. (Currently only supports sketches)&quot;&quot;&quot;</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">&quot;entity_mirror_across_edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_mirror_across_edge&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="edit_mode_enter">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.edit_mode_enter.html#kittycad.models.modeling_cmd.edit_mode_enter">[docs]</a>
<span class="k">class</span> <span class="nc">edit_mode_enter</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Enter edit mode&quot;&quot;&quot;</span>
<span class="n">target</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">&quot;edit_mode_enter&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;edit_mode_enter&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="select_with_point">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.select_with_point.html#kittycad.models.modeling_cmd.select_with_point">[docs]</a>
<span class="k">class</span> <span class="nc">select_with_point</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Modifies the selection by simulating a \&quot;mouse click\&quot; at the given x,y window coordinate Returns ID of whatever was selected.&quot;&quot;&quot;</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">&quot;select_with_point&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;select_with_point&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="select_add">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.select_add.html#kittycad.models.modeling_cmd.select_add">[docs]</a>
<span class="k">class</span> <span class="nc">select_add</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Adds one or more entities (by UUID) to the selection.&quot;&quot;&quot;</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">&quot;select_add&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;select_add&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="select_remove">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.select_remove.html#kittycad.models.modeling_cmd.select_remove">[docs]</a>
<span class="k">class</span> <span class="nc">select_remove</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Removes one or more entities (by UUID) from the selection.&quot;&quot;&quot;</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">&quot;select_remove&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;select_remove&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="scene_clear_all">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.scene_clear_all.html#kittycad.models.modeling_cmd.scene_clear_all">[docs]</a>
<span class="k">class</span> <span class="nc">scene_clear_all</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Removes all of the Objects in the scene&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;scene_clear_all&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;scene_clear_all&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="select_replace">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.select_replace.html#kittycad.models.modeling_cmd.select_replace">[docs]</a>
<span class="k">class</span> <span class="nc">select_replace</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Replaces current selection with these entities (by UUID).&quot;&quot;&quot;</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">&quot;select_replace&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;select_replace&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="highlight_set_entity">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.highlight_set_entity.html#kittycad.models.modeling_cmd.highlight_set_entity">[docs]</a>
<span class="k">class</span> <span class="nc">highlight_set_entity</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Changes the current highlighted entity to whichever one is at the given window coordinate. If there&#39;s no entity at this location, clears the highlight.&quot;&quot;&quot;</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">&quot;highlight_set_entity&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;highlight_set_entity&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="highlight_set_entities">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.highlight_set_entities.html#kittycad.models.modeling_cmd.highlight_set_entities">[docs]</a>
<span class="k">class</span> <span class="nc">highlight_set_entities</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Changes the current highlighted entity to these entities.&quot;&quot;&quot;</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">&quot;highlight_set_entities&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;highlight_set_entities&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="new_annotation">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.new_annotation.html#kittycad.models.modeling_cmd.new_annotation">[docs]</a>
<span class="k">class</span> <span class="nc">new_annotation</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a new annotation&quot;&quot;&quot;</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">&quot;new_annotation&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;new_annotation&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="update_annotation">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.update_annotation.html#kittycad.models.modeling_cmd.update_annotation">[docs]</a>
<span class="k">class</span> <span class="nc">update_annotation</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Update an annotation&quot;&quot;&quot;</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">&quot;update_annotation&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;update_annotation&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="edge_lines_visible">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.edge_lines_visible.html#kittycad.models.modeling_cmd.edge_lines_visible">[docs]</a>
<span class="k">class</span> <span class="nc">edge_lines_visible</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Changes visibility of scene-wide edge lines on brep solids&quot;&quot;&quot;</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">&quot;edge_lines_visible&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;edge_lines_visible&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="object_visible">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.object_visible.html#kittycad.models.modeling_cmd.object_visible">[docs]</a>
<span class="k">class</span> <span class="nc">object_visible</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Hide or show an object&quot;&quot;&quot;</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">&quot;object_visible&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;object_visible&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="object_bring_to_front">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.object_bring_to_front.html#kittycad.models.modeling_cmd.object_bring_to_front">[docs]</a>
<span class="k">class</span> <span class="nc">object_bring_to_front</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Bring an object to the front of the scene&quot;&quot;&quot;</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">&quot;object_bring_to_front&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;object_bring_to_front&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="object_set_material_params_pbr">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.object_set_material_params_pbr.html#kittycad.models.modeling_cmd.object_set_material_params_pbr">[docs]</a>
<span class="k">class</span> <span class="nc">object_set_material_params_pbr</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the material properties of an object&quot;&quot;&quot;</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">&quot;object_set_material_params_pbr&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;object_set_material_params_pbr&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="get_entity_type">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.get_entity_type.html#kittycad.models.modeling_cmd.get_entity_type">[docs]</a>
<span class="k">class</span> <span class="nc">get_entity_type</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What type of entity is this?&quot;&quot;&quot;</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">&quot;get_entity_type&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;get_entity_type&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_get_all_edge_faces">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_get_all_edge_faces.html#kittycad.models.modeling_cmd.solid3d_get_all_edge_faces">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_get_all_edge_faces</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets all faces which use the given edge.&quot;&quot;&quot;</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">&quot;solid3d_get_all_edge_faces&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_get_all_edge_faces&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid2d_add_hole">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid2d_add_hole.html#kittycad.models.modeling_cmd.solid2d_add_hole">[docs]</a>
<span class="k">class</span> <span class="nc">solid2d_add_hole</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add a hole to a Solid2d object before extruding it.&quot;&quot;&quot;</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">&quot;solid2d_add_hole&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid2d_add_hole&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_get_all_opposite_edges">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_get_all_opposite_edges.html#kittycad.models.modeling_cmd.solid3d_get_all_opposite_edges">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_get_all_opposite_edges</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets all edges which are opposite the given edge, across all possible faces.&quot;&quot;&quot;</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">&quot;solid3d_get_all_opposite_edges&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_get_all_opposite_edges&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_get_opposite_edge">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_get_opposite_edge.html#kittycad.models.modeling_cmd.solid3d_get_opposite_edge">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_get_opposite_edge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets the edge opposite the given edge, along the given face.&quot;&quot;&quot;</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">&quot;solid3d_get_opposite_edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_get_opposite_edge&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_get_next_adjacent_edge">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_get_next_adjacent_edge.html#kittycad.models.modeling_cmd.solid3d_get_next_adjacent_edge">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_get_next_adjacent_edge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets the next adjacent edge for the given edge, along the given face.&quot;&quot;&quot;</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">&quot;solid3d_get_next_adjacent_edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_get_next_adjacent_edge&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_get_prev_adjacent_edge">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_get_prev_adjacent_edge.html#kittycad.models.modeling_cmd.solid3d_get_prev_adjacent_edge">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_get_prev_adjacent_edge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets the previous adjacent edge for the given edge, along the given face.&quot;&quot;&quot;</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">&quot;solid3d_get_prev_adjacent_edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_get_prev_adjacent_edge&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_fillet_edge">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_fillet_edge.html#kittycad.models.modeling_cmd.solid3d_fillet_edge">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_fillet_edge</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fillets the given edge with the specified radius.&quot;&quot;&quot;</span>
<span class="n">cut_type</span><span class="p">:</span> <span class="n">CutType</span> <span class="o">=</span> <span class="s2">&quot;fillet&quot;</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="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">&quot;solid3d_fillet_edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_fillet_edge&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="face_is_planar">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.face_is_planar.html#kittycad.models.modeling_cmd.face_is_planar">[docs]</a>
<span class="k">class</span> <span class="nc">face_is_planar</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Determines whether a brep face is planar and returns its surface-local planar axes if so&quot;&quot;&quot;</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">&quot;face_is_planar&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;face_is_planar&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="face_get_position">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.face_get_position.html#kittycad.models.modeling_cmd.face_get_position">[docs]</a>
<span class="k">class</span> <span class="nc">face_get_position</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Determines a position on a brep face evaluated by parameters u,v&quot;&quot;&quot;</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">&quot;face_get_position&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;face_get_position&quot;</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="face_get_center">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.face_get_center.html#kittycad.models.modeling_cmd.face_get_center">[docs]</a>
<span class="k">class</span> <span class="nc">face_get_center</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtains the surface \&quot;center of mass\&quot; &quot;&quot;&quot;</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">&quot;face_get_center&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;face_get_center&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="face_get_gradient">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.face_get_gradient.html#kittycad.models.modeling_cmd.face_get_gradient">[docs]</a>
<span class="k">class</span> <span class="nc">face_get_gradient</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Determines the gradient (dFdu, dFdv) + normal vector on a brep face evaluated by parameters u,v&quot;&quot;&quot;</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">&quot;face_get_gradient&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;face_get_gradient&quot;</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="send_object">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.send_object.html#kittycad.models.modeling_cmd.send_object">[docs]</a>
<span class="k">class</span> <span class="nc">send_object</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Send object to front or back.&quot;&quot;&quot;</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">&quot;send_object&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;send_object&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_set_opacity">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_set_opacity.html#kittycad.models.modeling_cmd.entity_set_opacity">[docs]</a>
<span class="k">class</span> <span class="nc">entity_set_opacity</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set opacity of the entity.&quot;&quot;&quot;</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">&quot;entity_set_opacity&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_set_opacity&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="entity_fade">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.entity_fade.html#kittycad.models.modeling_cmd.entity_fade">[docs]</a>
<span class="k">class</span> <span class="nc">entity_fade</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fade entity in or out.&quot;&quot;&quot;</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">&quot;entity_fade&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;entity_fade&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="make_plane">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.make_plane.html#kittycad.models.modeling_cmd.make_plane">[docs]</a>
<span class="k">class</span> <span class="nc">make_plane</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Make a new plane&quot;&quot;&quot;</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">&quot;make_plane&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;make_plane&quot;</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="plane_set_color">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.plane_set_color.html#kittycad.models.modeling_cmd.plane_set_color">[docs]</a>
<span class="k">class</span> <span class="nc">plane_set_color</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the color of a plane.&quot;&quot;&quot;</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">&quot;plane_set_color&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;plane_set_color&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="set_tool">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_tool.html#kittycad.models.modeling_cmd.set_tool">[docs]</a>
<span class="k">class</span> <span class="nc">set_tool</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the current tool.&quot;&quot;&quot;</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">&quot;set_tool&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_tool&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="mouse_move">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.mouse_move.html#kittycad.models.modeling_cmd.mouse_move">[docs]</a>
<span class="k">class</span> <span class="nc">mouse_move</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Send a mouse move event&quot;&quot;&quot;</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">&quot;mouse_move&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;mouse_move&quot;</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="mouse_click">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.mouse_click.html#kittycad.models.modeling_cmd.mouse_click">[docs]</a>
<span class="k">class</span> <span class="nc">mouse_click</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Send a mouse click event Updates modified/selected entities.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;mouse_click&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;mouse_click&quot;</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="sketch_mode_disable">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.sketch_mode_disable.html#kittycad.models.modeling_cmd.sketch_mode_disable">[docs]</a>
<span class="k">class</span> <span class="nc">sketch_mode_disable</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;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.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;sketch_mode_disable&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;sketch_mode_disable&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="get_sketch_mode_plane">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.get_sketch_mode_plane.html#kittycad.models.modeling_cmd.get_sketch_mode_plane">[docs]</a>
<span class="k">class</span> <span class="nc">get_sketch_mode_plane</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the plane for sketch mode.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;get_sketch_mode_plane&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;get_sketch_mode_plane&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="curve_set_constraint">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.curve_set_constraint.html#kittycad.models.modeling_cmd.curve_set_constraint">[docs]</a>
<span class="k">class</span> <span class="nc">curve_set_constraint</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the plane for sketch mode.&quot;&quot;&quot;</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">&quot;curve_set_constraint&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;curve_set_constraint&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="enable_sketch_mode">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.enable_sketch_mode.html#kittycad.models.modeling_cmd.enable_sketch_mode">[docs]</a>
<span class="k">class</span> <span class="nc">enable_sketch_mode</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Sketch on some entity (e.g. a plane, a face).&quot;&quot;&quot;</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">&quot;enable_sketch_mode&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;enable_sketch_mode&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="set_background_color">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_background_color.html#kittycad.models.modeling_cmd.set_background_color">[docs]</a>
<span class="k">class</span> <span class="nc">set_background_color</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the background color of the scene.&quot;&quot;&quot;</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">&quot;set_background_color&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_background_color&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="set_current_tool_properties">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_current_tool_properties.html#kittycad.models.modeling_cmd.set_current_tool_properties">[docs]</a>
<span class="k">class</span> <span class="nc">set_current_tool_properties</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the properties of the tool lines for the scene.&quot;&quot;&quot;</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">&quot;set_current_tool_properties&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_current_tool_properties&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="set_default_system_properties">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_default_system_properties.html#kittycad.models.modeling_cmd.set_default_system_properties">[docs]</a>
<span class="k">class</span> <span class="nc">set_default_system_properties</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the default system properties used when a specific property isn&#39;t set.&quot;&quot;&quot;</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">&quot;set_default_system_properties&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_default_system_properties&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="curve_get_type">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.curve_get_type.html#kittycad.models.modeling_cmd.curve_get_type">[docs]</a>
<span class="k">class</span> <span class="nc">curve_get_type</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get type of the given curve.&quot;&quot;&quot;</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">&quot;curve_get_type&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;curve_get_type&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="curve_get_control_points">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.curve_get_control_points.html#kittycad.models.modeling_cmd.curve_get_control_points">[docs]</a>
<span class="k">class</span> <span class="nc">curve_get_control_points</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get control points of the given curve.&quot;&quot;&quot;</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">&quot;curve_get_control_points&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;curve_get_control_points&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="take_snapshot">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.take_snapshot.html#kittycad.models.modeling_cmd.take_snapshot">[docs]</a>
<span class="k">class</span> <span class="nc">take_snapshot</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Take a snapshot of the current view.&quot;&quot;&quot;</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">&quot;take_snapshot&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;take_snapshot&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="make_axes_gizmo">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.make_axes_gizmo.html#kittycad.models.modeling_cmd.make_axes_gizmo">[docs]</a>
<span class="k">class</span> <span class="nc">make_axes_gizmo</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Add a gizmo showing the axes.&quot;&quot;&quot;</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">&quot;make_axes_gizmo&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;make_axes_gizmo&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="path_get_info">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.path_get_info.html#kittycad.models.modeling_cmd.path_get_info">[docs]</a>
<span class="k">class</span> <span class="nc">path_get_info</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Query the given path.&quot;&quot;&quot;</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">&quot;path_get_info&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;path_get_info&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="path_get_curve_uuids_for_vertices">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.path_get_curve_uuids_for_vertices.html#kittycad.models.modeling_cmd.path_get_curve_uuids_for_vertices">[docs]</a>
<span class="k">class</span> <span class="nc">path_get_curve_uuids_for_vertices</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtain curve ids for vertex ids&quot;&quot;&quot;</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">&quot;path_get_curve_uuids_for_vertices&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">&quot;path_get_curve_uuids_for_vertices&quot;</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="path_get_curve_uuid">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.path_get_curve_uuid.html#kittycad.models.modeling_cmd.path_get_curve_uuid">[docs]</a>
<span class="k">class</span> <span class="nc">path_get_curve_uuid</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtain curve id by index&quot;&quot;&quot;</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">&quot;path_get_curve_uuid&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;path_get_curve_uuid&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="path_get_vertex_uuids">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.path_get_vertex_uuids.html#kittycad.models.modeling_cmd.path_get_vertex_uuids">[docs]</a>
<span class="k">class</span> <span class="nc">path_get_vertex_uuids</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtain vertex ids for a path&quot;&quot;&quot;</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">&quot;path_get_vertex_uuids&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;path_get_vertex_uuids&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="path_get_sketch_target_uuid">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.path_get_sketch_target_uuid.html#kittycad.models.modeling_cmd.path_get_sketch_target_uuid">[docs]</a>
<span class="k">class</span> <span class="nc">path_get_sketch_target_uuid</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Obtain the sketch target id (if the path was drawn in sketchmode) for a path&quot;&quot;&quot;</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">&quot;path_get_sketch_target_uuid&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;path_get_sketch_target_uuid&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="handle_mouse_drag_start">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.handle_mouse_drag_start.html#kittycad.models.modeling_cmd.handle_mouse_drag_start">[docs]</a>
<span class="k">class</span> <span class="nc">handle_mouse_drag_start</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Start dragging the mouse.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;handle_mouse_drag_start&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;handle_mouse_drag_start&quot;</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="handle_mouse_drag_move">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.handle_mouse_drag_move.html#kittycad.models.modeling_cmd.handle_mouse_drag_move">[docs]</a>
<span class="k">class</span> <span class="nc">handle_mouse_drag_move</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Continue dragging the mouse.&quot;&quot;&quot;</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">&quot;handle_mouse_drag_move&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;handle_mouse_drag_move&quot;</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="handle_mouse_drag_end">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.handle_mouse_drag_end.html#kittycad.models.modeling_cmd.handle_mouse_drag_end">[docs]</a>
<span class="k">class</span> <span class="nc">handle_mouse_drag_end</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Stop dragging the mouse.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;handle_mouse_drag_end&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;handle_mouse_drag_end&quot;</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="remove_scene_objects">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.remove_scene_objects.html#kittycad.models.modeling_cmd.remove_scene_objects">[docs]</a>
<span class="k">class</span> <span class="nc">remove_scene_objects</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Remove scene objects.&quot;&quot;&quot;</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">&quot;remove_scene_objects&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;remove_scene_objects&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="plane_intersect_and_project">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.plane_intersect_and_project.html#kittycad.models.modeling_cmd.plane_intersect_and_project">[docs]</a>
<span class="k">class</span> <span class="nc">plane_intersect_and_project</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Utility method. Performs both a ray cast and projection to plane-local coordinates. Returns the plane coordinates for the given window coordinates.&quot;&quot;&quot;</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">&quot;plane_intersect_and_project&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;plane_intersect_and_project&quot;</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="curve_get_end_points">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.curve_get_end_points.html#kittycad.models.modeling_cmd.curve_get_end_points">[docs]</a>
<span class="k">class</span> <span class="nc">curve_get_end_points</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Find the start and end of a curve.&quot;&quot;&quot;</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">&quot;curve_get_end_points&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;curve_get_end_points&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="reconfigure_stream">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.reconfigure_stream.html#kittycad.models.modeling_cmd.reconfigure_stream">[docs]</a>
<span class="k">class</span> <span class="nc">reconfigure_stream</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Reconfigure the stream.&quot;&quot;&quot;</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">&quot;reconfigure_stream&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;reconfigure_stream&quot;</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="import_files">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.import_files.html#kittycad.models.modeling_cmd.import_files">[docs]</a>
<span class="k">class</span> <span class="nc">import_files</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Import files to the current model.&quot;&quot;&quot;</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">&quot;import_files&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;import_files&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="set_scene_units">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_scene_units.html#kittycad.models.modeling_cmd.set_scene_units">[docs]</a>
<span class="k">class</span> <span class="nc">set_scene_units</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set the units of the scene. For all following commands, the units will be interpreted as the given units.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;set_scene_units&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_scene_units&quot;</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="mass">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.mass.html#kittycad.models.modeling_cmd.mass">[docs]</a>
<span class="k">class</span> <span class="nc">mass</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the mass of entities in the scene or the default scene.&quot;&quot;&quot;</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">&quot;mass&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;mass&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="density">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.density.html#kittycad.models.modeling_cmd.density">[docs]</a>
<span class="k">class</span> <span class="nc">density</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the density of entities in the scene or the default scene.&quot;&quot;&quot;</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">&quot;density&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;density&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="volume">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.volume.html#kittycad.models.modeling_cmd.volume">[docs]</a>
<span class="k">class</span> <span class="nc">volume</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the volume of entities in the scene or the default scene.&quot;&quot;&quot;</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">&quot;volume&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;volume&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="center_of_mass">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.center_of_mass.html#kittycad.models.modeling_cmd.center_of_mass">[docs]</a>
<span class="k">class</span> <span class="nc">center_of_mass</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the center of mass of entities in the scene or the default scene.&quot;&quot;&quot;</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">&quot;center_of_mass&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;center_of_mass&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="surface_area">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.surface_area.html#kittycad.models.modeling_cmd.surface_area">[docs]</a>
<span class="k">class</span> <span class="nc">surface_area</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the surface area of entities in the scene or the default scene.&quot;&quot;&quot;</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">&quot;surface_area&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;surface_area&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="default_camera_focus_on">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_focus_on.html#kittycad.models.modeling_cmd.default_camera_focus_on">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_focus_on</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Focus the default camera upon an object in the scene.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;default_camera_focus_on&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default_camera_focus_on&quot;</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="set_selection_type">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_selection_type.html#kittycad.models.modeling_cmd.set_selection_type">[docs]</a>
<span class="k">class</span> <span class="nc">set_selection_type</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;When you select some entity with the current tool, what should happen to the entity?&quot;&quot;&quot;</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">&quot;set_selection_type&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_selection_type&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="set_selection_filter">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.set_selection_filter.html#kittycad.models.modeling_cmd.set_selection_filter">[docs]</a>
<span class="k">class</span> <span class="nc">set_selection_filter</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;What kind of entities can be selected?&quot;&quot;&quot;</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">&quot;set_selection_filter&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;set_selection_filter&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="default_camera_set_orthographic">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_set_orthographic.html#kittycad.models.modeling_cmd.default_camera_set_orthographic">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_set_orthographic</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Use orthographic projection.&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;default_camera_set_orthographic&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default_camera_set_orthographic&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="default_camera_set_perspective">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_set_perspective.html#kittycad.models.modeling_cmd.default_camera_set_perspective">[docs]</a>
<span class="k">class</span> <span class="nc">default_camera_set_perspective</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Use perspective projection.&quot;&quot;&quot;</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">&quot;default_camera_set_perspective&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;default_camera_set_perspective&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="zoom_to_fit">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.zoom_to_fit.html#kittycad.models.modeling_cmd.zoom_to_fit">[docs]</a>
<span class="k">class</span> <span class="nc">zoom_to_fit</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fit the view to the specified object(s).&quot;&quot;&quot;</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">&quot;zoom_to_fit&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;zoom_to_fit&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="view_isometric">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.view_isometric.html#kittycad.models.modeling_cmd.view_isometric">[docs]</a>
<span class="k">class</span> <span class="nc">view_isometric</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Fit the view to the scene with an isometric view.&quot;&quot;&quot;</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">&quot;view_isometric&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;view_isometric&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="solid3d_get_extrusion_face_info">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.solid3d_get_extrusion_face_info.html#kittycad.models.modeling_cmd.solid3d_get_extrusion_face_info">[docs]</a>
<span class="k">class</span> <span class="nc">solid3d_get_extrusion_face_info</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get a concise description of all of an extrusion&#39;s faces.&quot;&quot;&quot;</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">&quot;solid3d_get_extrusion_face_info&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;solid3d_get_extrusion_face_info&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="edit_mode_exit">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.edit_mode_exit.html#kittycad.models.modeling_cmd.edit_mode_exit">[docs]</a>
<span class="k">class</span> <span class="nc">edit_mode_exit</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Exit edit mode&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;edit_mode_exit&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;edit_mode_exit&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="select_clear">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.select_clear.html#kittycad.models.modeling_cmd.select_clear">[docs]</a>
<span class="k">class</span> <span class="nc">select_clear</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Clear the selection&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;select_clear&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;select_clear&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="select_get">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.select_get.html#kittycad.models.modeling_cmd.select_get">[docs]</a>
<span class="k">class</span> <span class="nc">select_get</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Find all IDs of selected entities&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;select_get&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;select_get&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<div class="viewcode-block" id="get_num_objects">
<a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.get_num_objects.html#kittycad.models.modeling_cmd.get_num_objects">[docs]</a>
<span class="k">class</span> <span class="nc">get_num_objects</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the number of objects in the scene&quot;&quot;&quot;</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;get_num_objects&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;get_num_objects&quot;</span>
<span class="n">model_config</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">protected_namespaces</span><span class="o">=</span><span class="p">())</span></div>
<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">start_path</span><span class="p">,</span>
<span class="n">move_path_pen</span><span class="p">,</span>
<span class="n">extend_path</span><span class="p">,</span>
<span class="n">extrude</span><span class="p">,</span>
<span class="n">revolve</span><span class="p">,</span>
<span class="n">solid3d_shell_face</span><span class="p">,</span>
<span class="n">revolve_about_edge</span><span class="p">,</span>
<span class="n">close_path</span><span class="p">,</span>
<span class="n">camera_drag_start</span><span class="p">,</span>
<span class="n">camera_drag_move</span><span class="p">,</span>
<span class="n">camera_drag_end</span><span class="p">,</span>
<span class="n">default_camera_get_settings</span><span class="p">,</span>
<span class="n">default_camera_look_at</span><span class="p">,</span>
<span class="n">default_camera_perspective_settings</span><span class="p">,</span>
<span class="n">default_camera_zoom</span><span class="p">,</span>
<span class="n">export</span><span class="p">,</span>
<span class="n">entity_get_parent_id</span><span class="p">,</span>
<span class="n">entity_get_num_children</span><span class="p">,</span>
<span class="n">entity_get_child_uuid</span><span class="p">,</span>
<span class="n">entity_get_all_child_uuids</span><span class="p">,</span>
<span class="n">entity_get_sketch_paths</span><span class="p">,</span>
<span class="n">entity_get_distance</span><span class="p">,</span>
<span class="n">entity_linear_pattern_transform</span><span class="p">,</span>
<span class="n">entity_linear_pattern</span><span class="p">,</span>
<span class="n">entity_circular_pattern</span><span class="p">,</span>
<span class="n">entity_make_helix</span><span class="p">,</span>
<span class="n">entity_mirror</span><span class="p">,</span>
<span class="n">entity_mirror_across_edge</span><span class="p">,</span>
<span class="n">edit_mode_enter</span><span class="p">,</span>
<span class="n">select_with_point</span><span class="p">,</span>
<span class="n">select_add</span><span class="p">,</span>
<span class="n">select_remove</span><span class="p">,</span>
<span class="n">scene_clear_all</span><span class="p">,</span>
<span class="n">select_replace</span><span class="p">,</span>
<span class="n">highlight_set_entity</span><span class="p">,</span>
<span class="n">highlight_set_entities</span><span class="p">,</span>
<span class="n">new_annotation</span><span class="p">,</span>
<span class="n">update_annotation</span><span class="p">,</span>
<span class="n">edge_lines_visible</span><span class="p">,</span>
<span class="n">object_visible</span><span class="p">,</span>
<span class="n">object_bring_to_front</span><span class="p">,</span>
<span class="n">object_set_material_params_pbr</span><span class="p">,</span>
<span class="n">get_entity_type</span><span class="p">,</span>
<span class="n">solid3d_get_all_edge_faces</span><span class="p">,</span>
<span class="n">solid2d_add_hole</span><span class="p">,</span>
<span class="n">solid3d_get_all_opposite_edges</span><span class="p">,</span>
<span class="n">solid3d_get_opposite_edge</span><span class="p">,</span>
<span class="n">solid3d_get_next_adjacent_edge</span><span class="p">,</span>
<span class="n">solid3d_get_prev_adjacent_edge</span><span class="p">,</span>
<span class="n">solid3d_fillet_edge</span><span class="p">,</span>
<span class="n">face_is_planar</span><span class="p">,</span>
<span class="n">face_get_position</span><span class="p">,</span>
<span class="n">face_get_center</span><span class="p">,</span>
<span class="n">face_get_gradient</span><span class="p">,</span>
<span class="n">send_object</span><span class="p">,</span>
<span class="n">entity_set_opacity</span><span class="p">,</span>
<span class="n">entity_fade</span><span class="p">,</span>
<span class="n">make_plane</span><span class="p">,</span>
<span class="n">plane_set_color</span><span class="p">,</span>
<span class="n">set_tool</span><span class="p">,</span>
<span class="n">mouse_move</span><span class="p">,</span>
<span class="n">mouse_click</span><span class="p">,</span>
<span class="n">sketch_mode_disable</span><span class="p">,</span>
<span class="n">get_sketch_mode_plane</span><span class="p">,</span>
<span class="n">curve_set_constraint</span><span class="p">,</span>
<span class="n">enable_sketch_mode</span><span class="p">,</span>
<span class="n">set_background_color</span><span class="p">,</span>
<span class="n">set_current_tool_properties</span><span class="p">,</span>
<span class="n">set_default_system_properties</span><span class="p">,</span>
<span class="n">curve_get_type</span><span class="p">,</span>
<span class="n">curve_get_control_points</span><span class="p">,</span>
<span class="n">take_snapshot</span><span class="p">,</span>
<span class="n">make_axes_gizmo</span><span class="p">,</span>
<span class="n">path_get_info</span><span class="p">,</span>
<span class="n">path_get_curve_uuids_for_vertices</span><span class="p">,</span>
<span class="n">path_get_curve_uuid</span><span class="p">,</span>
<span class="n">path_get_vertex_uuids</span><span class="p">,</span>
<span class="n">path_get_sketch_target_uuid</span><span class="p">,</span>
<span class="n">handle_mouse_drag_start</span><span class="p">,</span>
<span class="n">handle_mouse_drag_move</span><span class="p">,</span>
<span class="n">handle_mouse_drag_end</span><span class="p">,</span>
<span class="n">remove_scene_objects</span><span class="p">,</span>
<span class="n">plane_intersect_and_project</span><span class="p">,</span>
<span class="n">curve_get_end_points</span><span class="p">,</span>
<span class="n">reconfigure_stream</span><span class="p">,</span>
<span class="n">import_files</span><span class="p">,</span>
<span class="n">set_scene_units</span><span class="p">,</span>
<span class="n">mass</span><span class="p">,</span>
<span class="n">density</span><span class="p">,</span>
<span class="n">volume</span><span class="p">,</span>
<span class="n">center_of_mass</span><span class="p">,</span>
<span class="n">surface_area</span><span class="p">,</span>
<span class="n">default_camera_focus_on</span><span class="p">,</span>
<span class="n">set_selection_type</span><span class="p">,</span>
<span class="n">set_selection_filter</span><span class="p">,</span>
<span class="n">default_camera_set_orthographic</span><span class="p">,</span>
<span class="n">default_camera_set_perspective</span><span class="p">,</span>
<span class="n">zoom_to_fit</span><span class="p">,</span>
<span class="n">view_isometric</span><span class="p">,</span>
<span class="n">solid3d_get_extrusion_face_info</span><span class="p">,</span>
<span class="n">edit_mode_exit</span><span class="p">,</span>
<span class="n">select_clear</span><span class="p">,</span>
<span class="n">select_get</span><span class="p">,</span>
<span class="n">get_num_objects</span><span class="p">,</span>
<span class="p">],</span>
<span class="n">Field</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s2">&quot;type&quot;</span><span class="p">),</span>
<span class="p">]</span>
<span class="p">]</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 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>
Reference in New Issue View Git Blame Copy Permalink