919 lines
82 KiB
HTML
919 lines
82 KiB
HTML
<!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 — kittycad v0.5.9 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 data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=19ad864f"></script>
|
|
<script src="../../../_static/doctools.js?v=888ff710"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=4825356b"></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.5.9
|
|
</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">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.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.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.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.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">"""Start a path."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"start_path"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"start_path"</span></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">"""Move the path's "pen"."""</span>
|
|
|
|
<span class="n">path</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="n">to</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"move_path_pen"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"move_path_pen"</span></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">"""Extend a path by adding a new segment which starts at the path's "pen". If no "pen" location has been set before (via `MovePen`), then the pen is at the origin."""</span>
|
|
|
|
<span class="n">path</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="n">segment</span><span class="p">:</span> <span class="n">PathSegment</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"extend_path"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"extend_path"</span></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">"""Extrude a 2D solid."""</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="nb">float</span>
|
|
|
|
<span class="n">target</span><span class="p">:</span> <span class="n">ModelingCmdId</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"extrude"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"extrude"</span></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">"""Closes a path, converting it to a 2D solid."""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"close_path"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"close_path"</span></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">"""Camera drag started."""</span>
|
|
|
|
<span class="n">interaction</span><span class="p">:</span> <span class="n">CameraDragInteractionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"camera_drag_start"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"camera_drag_start"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Camera drag continued."""</span>
|
|
|
|
<span class="n">interaction</span><span class="p">:</span> <span class="n">CameraDragInteractionType</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"camera_drag_move"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"camera_drag_move"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Camera drag ended."""</span>
|
|
|
|
<span class="n">interaction</span><span class="p">:</span> <span class="n">CameraDragInteractionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"camera_drag_end"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"camera_drag_end"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Change what the default camera is looking at."""</span>
|
|
|
|
<span class="n">center</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_look_at"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_look_at"</span>
|
|
|
|
<span class="n">up</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">vantage</span><span class="p">:</span> <span class="n">Point3d</span></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">"""Adjust zoom of the default camera."""</span>
|
|
|
|
<span class="n">magnitude</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_zoom"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_zoom"</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="default_camera_enable_sketch_mode"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_enable_sketch_mode.html#kittycad.models.modeling_cmd.default_camera_enable_sketch_mode">[docs]</a><span class="k">class</span> <span class="nc">default_camera_enable_sketch_mode</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Enable sketch mode, where users can sketch 2D geometry. Users choose a plane to sketch on."""</span>
|
|
|
|
<span class="n">animated</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">distance_to_plane</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">origin</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">ortho</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">"default_camera_enable_sketch_mode"</span>
|
|
<span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_enable_sketch_mode"</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></div>
|
|
|
|
|
|
<div class="viewcode-block" id="default_camera_disable_sketch_mode"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.default_camera_disable_sketch_mode.html#kittycad.models.modeling_cmd.default_camera_disable_sketch_mode">[docs]</a><span class="k">class</span> <span class="nc">default_camera_disable_sketch_mode</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Disable sketch mode, from the default camera."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span>
|
|
<span class="s2">"default_camera_disable_sketch_mode"</span>
|
|
<span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_disable_sketch_mode"</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">"""Focus default camera on object."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"default_camera_focus_on"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"default_camera_focus_on"</span>
|
|
|
|
<span class="n">uuid</span><span class="p">:</span> <span class="nb">str</span></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">"""Export the scene to a file."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">format</span><span class="p">:</span> <span class="n">OutputFormat</span>
|
|
|
|
<span class="n">source_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">"export"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"export"</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">"""What is this entity's parent?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_parent_id"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_parent_id"</span></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">"""How many children does the entity have?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_num_children"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_num_children"</span></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">"""What is the UUID of this entity's n-th child?"""</span>
|
|
|
|
<span class="n">child_index</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_child_uuid"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_child_uuid"</span></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">"""What are all UUIDs of this entity's children?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_get_all_child_uuids"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_get_all_child_uuids"</span></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">"""Enter edit mode"""</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">"edit_mode_enter"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"edit_mode_enter"</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">"""Exit edit mode"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"edit_mode_exit"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"edit_mode_exit"</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">"""Modifies the selection by simulating a "mouse click" at the given x,y window coordinate Returns ID of whatever was selected."""</span>
|
|
|
|
<span class="n">selected_at_window</span><span class="p">:</span> <span class="n">Point2d</span>
|
|
|
|
<span class="n">selection_type</span><span class="p">:</span> <span class="n">SceneSelectionType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_with_point"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_with_point"</span></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">"""Clear the selection"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_clear"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_clear"</span></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">"""Adds one or more entities (by UUID) to the selection."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_add"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_add"</span></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">"""Removes one or more entities (by UUID) from the selection."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_remove"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_remove"</span></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">"""Replaces the current selection with these new entities (by UUID). Equivalent to doing SelectClear then SelectAdd."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_replace"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_replace"</span></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">"""Find all IDs of selected entities"""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"select_get"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"select_get"</span></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">"""Changes the current highlighted entity to whichever one is at the given window coordinate. If there's no entity at this location, clears the highlight."""</span>
|
|
|
|
<span class="n">selected_at_window</span><span class="p">:</span> <span class="n">Point2d</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"highlight_set_entity"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"highlight_set_entity"</span></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">"""Changes the current highlighted entity to these entities."""</span>
|
|
|
|
<span class="n">entities</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"highlight_set_entities"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"highlight_set_entities"</span></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">"""Create a new annotation"""</span>
|
|
|
|
<span class="n">annotation_type</span><span class="p">:</span> <span class="n">AnnotationType</span>
|
|
|
|
<span class="n">clobber</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">options</span><span class="p">:</span> <span class="n">AnnotationOptions</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"new_annotation"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"new_annotation"</span></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">"""Update an annotation"""</span>
|
|
|
|
<span class="n">annotation_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">options</span><span class="p">:</span> <span class="n">AnnotationOptions</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"update_annotation"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"update_annotation"</span></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">"""Hide or show an object"""</span>
|
|
|
|
<span class="n">hidden</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"object_visible"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"object_visible"</span></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">"""Bring an object to the front of the scene"""</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"object_bring_to_front"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"object_bring_to_front"</span></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">"""What type of entity is this?"""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"get_entity_type"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"get_entity_type"</span></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">"""Add a hole to a Solid2d object before extruding it."""</span>
|
|
|
|
<span class="n">hole_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid2d_add_hole"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid2d_add_hole"</span></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">"""Gets all faces which use the given edge."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_all_edge_faces"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_all_edge_faces"</span></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">"""Gets all edges which are opposite the given edge, across all possible faces."""</span>
|
|
|
|
<span class="n">along_vector</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Point3d</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_all_opposite_edges"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_all_opposite_edges"</span></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">"""Gets the edge opposite the given edge, along the given face."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_opposite_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_opposite_edge"</span></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">"""Gets the next adjacent edge for the given edge, along the given face."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_next_adjacent_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_next_adjacent_edge"</span></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">"""Gets the previous adjacent edge for the given edge, along the given face."""</span>
|
|
|
|
<span class="n">edge_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">face_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"solid3d_get_prev_adjacent_edge"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"solid3d_get_prev_adjacent_edge"</span></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">"""Sends object to front or back."""</span>
|
|
|
|
<span class="n">front</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"send_object"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"send_object"</span></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">"""Set opacity of the entity."""</span>
|
|
|
|
<span class="n">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">opacity</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_set_opacity"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_set_opacity"</span></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">"""Fade the entity in or out."""</span>
|
|
|
|
<span class="n">duration_seconds</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">entity_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="n">fade_in</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"entity_fade"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"entity_fade"</span></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">"""Make a plane."""</span>
|
|
|
|
<span class="n">clobber</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">hide</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="n">origin</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">size</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"make_plane"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"make_plane"</span>
|
|
|
|
<span class="n">x_axis</span><span class="p">:</span> <span class="n">Point3d</span>
|
|
|
|
<span class="n">y_axis</span><span class="p">:</span> <span class="n">Point3d</span></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">"""Set the plane's color."""</span>
|
|
|
|
<span class="n">color</span><span class="p">:</span> <span class="n">Color</span>
|
|
|
|
<span class="n">plane_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"plane_set_color"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"plane_set_color"</span></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">"""Set the active tool."""</span>
|
|
|
|
<span class="n">tool</span><span class="p">:</span> <span class="n">SceneToolType</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"set_tool"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"set_tool"</span></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">"""Send a mouse move event."""</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"mouse_move"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"mouse_move"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Send a mouse click event. Updates modified/selected entities."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"mouse_click"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"mouse_click"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="sketch_mode_enable"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.modeling_cmd.sketch_mode_enable.html#kittycad.models.modeling_cmd.sketch_mode_enable">[docs]</a><span class="k">class</span> <span class="nc">sketch_mode_enable</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Enable sketch mode on the given plane."""</span>
|
|
|
|
<span class="n">animated</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">disable_camera_with_plane</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">ortho</span><span class="p">:</span> <span class="nb">bool</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">"sketch_mode_enable"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"sketch_mode_enable"</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">"""Disable sketch mode."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"sketch_mode_disable"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"sketch_mode_disable"</span></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">"""Get type of a given curve."""</span>
|
|
|
|
<span class="n">curve_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_get_type"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_get_type"</span></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">"""Get control points of a given curve."""</span>
|
|
|
|
<span class="n">curve_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_get_control_points"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_get_control_points"</span></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">"""Take a snapshot."""</span>
|
|
|
|
<span class="nb">format</span><span class="p">:</span> <span class="n">ImageFormat</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"take_snapshot"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"take_snapshot"</span></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">"""Add a gizmo showing the axes."""</span>
|
|
|
|
<span class="n">clobber</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="n">gizmo_mode</span><span class="p">:</span> <span class="nb">bool</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"make_axes_gizmo"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"make_axes_gizmo"</span></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">"""Query the given path"""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_info"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_info"</span></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">"""Get curves for vertices within a path"""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span>
|
|
<span class="s2">"path_get_curve_uuids_for_vertices"</span>
|
|
<span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_curve_uuids_for_vertices"</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></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">"""Get vertices within a path"""</span>
|
|
|
|
<span class="n">path_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"path_get_vertex_uuids"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"path_get_vertex_uuids"</span></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">"""Start dragging mouse."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handle_mouse_drag_start"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handle_mouse_drag_start"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Continue dragging mouse."""</span>
|
|
|
|
<span class="n">sequence</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handle_mouse_drag_move"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handle_mouse_drag_move"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Stop dragging mouse."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"handle_mouse_drag_end"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"handle_mouse_drag_end"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Remove scene objects."""</span>
|
|
|
|
<span class="n">object_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"remove_scene_objects"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"remove_scene_objects"</span></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">"""Utility method. Performs both a ray cast and projection to plane-local coordinates. Returns the plane coordinates for the given window coordinates."""</span>
|
|
|
|
<span class="n">plane_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"plane_intersect_and_project"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"plane_intersect_and_project"</span>
|
|
|
|
<span class="n">window</span><span class="p">:</span> <span class="n">Point2d</span></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">"""Find the start and end of a curve."""</span>
|
|
|
|
<span class="n">curve_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_get_end_points"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_get_end_points"</span></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">"""Reconfigure the stream."""</span>
|
|
|
|
<span class="n">fps</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="n">height</span><span class="p">:</span> <span class="nb">int</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"reconfigure_stream"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"reconfigure_stream"</span>
|
|
|
|
<span class="n">width</span><span class="p">:</span> <span class="nb">int</span></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">"""Import files to the current model."""</span>
|
|
|
|
<span class="n">files</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">ImportFile</span><span class="p">]</span>
|
|
|
|
<span class="nb">format</span><span class="p">:</span> <span class="n">InputFormat</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"import_files"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"import_files"</span></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">"""Get the mass of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">material_density</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">material_density_unit</span><span class="p">:</span> <span class="n">UnitDensity</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitMass</span>
|
|
|
|
<span class="n">source_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">"mass"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"mass"</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">"""Get the density of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">material_mass</span><span class="p">:</span> <span class="nb">float</span>
|
|
|
|
<span class="n">material_mass_unit</span><span class="p">:</span> <span class="n">UnitMass</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitDensity</span>
|
|
|
|
<span class="n">source_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">"density"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"density"</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">"""Get the volume of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitVolume</span>
|
|
|
|
<span class="n">source_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">"volume"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"volume"</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">"""Get the center of mass of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitLength</span>
|
|
|
|
<span class="n">source_unit</span><span class="p">:</span> <span class="n">UnitLength</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"center_of_mass"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"center_of_mass"</span></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">"""Get the surface area of entities in the scene or the default scene."""</span>
|
|
|
|
<span class="n">entity_ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
|
|
|
|
<span class="n">output_unit</span><span class="p">:</span> <span class="n">UnitArea</span>
|
|
|
|
<span class="n">source_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">"surface_area"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"surface_area"</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">"""Get the plane of the sketch mode. This is useful for getting the normal of the plane after a user selects a plane."""</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"get_sketch_mode_plane"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"get_sketch_mode_plane"</span></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">"""Constrain a curve."""</span>
|
|
|
|
<span class="n">constraint_bound</span><span class="p">:</span> <span class="n">PathComponentConstraintBound</span>
|
|
|
|
<span class="n">constraint_type</span><span class="p">:</span> <span class="n">PathComponentConstraintType</span>
|
|
|
|
<span class="n">object_id</span><span class="p">:</span> <span class="nb">str</span>
|
|
|
|
<span class="nb">type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"curve_set_constraint"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"curve_set_constraint"</span></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">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_look_at</span><span class="p">,</span>
|
|
<span class="n">default_camera_zoom</span><span class="p">,</span>
|
|
<span class="n">default_camera_enable_sketch_mode</span><span class="p">,</span>
|
|
<span class="n">default_camera_disable_sketch_mode</span><span class="p">,</span>
|
|
<span class="n">default_camera_focus_on</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">edit_mode_enter</span><span class="p">,</span>
|
|
<span class="n">edit_mode_exit</span><span class="p">,</span>
|
|
<span class="n">select_with_point</span><span class="p">,</span>
|
|
<span class="n">select_clear</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">select_replace</span><span class="p">,</span>
|
|
<span class="n">select_get</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">object_visible</span><span class="p">,</span>
|
|
<span class="n">object_bring_to_front</span><span class="p">,</span>
|
|
<span class="n">get_entity_type</span><span class="p">,</span>
|
|
<span class="n">solid2d_add_hole</span><span class="p">,</span>
|
|
<span class="n">solid3d_get_all_edge_faces</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">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_enable</span><span class="p">,</span>
|
|
<span class="n">sketch_mode_disable</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_vertex_uuids</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">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">get_sketch_mode_plane</span><span class="p">,</span>
|
|
<span class="n">curve_set_constraint</span><span class="p">,</span>
|
|
<span class="p">],</span>
|
|
<span class="n">Field</span><span class="p">(</span><span class="n">discriminator</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
|
|
<span class="p">]</span>
|
|
<span class="p">]</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2023, 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> |