2023-05-04 00:58:06 -07:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2024-07-28 22:52:47 +00:00
< title > kittycad.models.modeling_cmd — kittycad v0.6.17 documentation< / title >
2023-05-04 00:58:06 -07:00
< 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]-->
2023-08-16 23:39:29 +00:00
< script src = "../../../_static/jquery.js?v=5d32c60e" > < / script >
< script src = "../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c" > < / script >
2024-07-28 22:52:47 +00:00
< script src = "../../../_static/documentation_options.js?v=a60b730d" > < / script >
< script src = "../../../_static/doctools.js?v=9a2dae69" > < / script >
< script src = "../../../_static/sphinx_highlight.js?v=dc90522c" > < / script >
2023-08-16 23:39:29 +00:00
< script src = "../../../_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "../../../_static/copybutton.js?v=f281be69" > < / script >
2023-05-04 00:58:06 -07:00
< 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" >
2024-07-28 22:52:47 +00:00
v0.6.17
2023-05-04 00:58:06 -07:00
< / 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 >
2023-05-23 21:30:43 +00:00
< li class = "breadcrumb-item active" > kittycad.models.modeling_cmd< / li >
2023-05-04 00:58:06 -07:00
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
2023-05-23 21:30:43 +00:00
< h1 > Source code for kittycad.models.modeling_cmd< / h1 > < div class = "highlight" > < pre >
2023-12-05 16:25:51 -08:00
< 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 >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "kn" > from< / span > < span class = "nn" > typing_extensions< / span > < span class = "kn" > import< / span > < span class = "n" > Annotated< / span >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.angle< / span > < span class = "kn" > import< / span > < span class = "n" > Angle< / span >
2023-08-16 23:39:29 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.camera_drag_interaction_type< / span > < span class = "kn" > import< / span > < span class = "n" > CameraDragInteractionType< / span >
2023-12-05 16:25:51 -08:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.color< / span > < span class = "kn" > import< / span > < span class = "n" > Color< / span >
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.modeling_cmd_id< / span > < span class = "kn" > import< / span > < span class = "n" > ModelingCmdId< / span >
2023-07-31 19:56:37 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.output_format< / span > < span class = "kn" > import< / span > < span class = "n" > OutputFormat< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.path_segment< / span > < span class = "kn" > import< / span > < span class = "n" > PathSegment< / span >
2024-07-28 22:52:47 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.perspective_camera_parameters< / span > < span class = "kn" > import< / span > < span class = "n" > PerspectiveCameraParameters< / span >
2023-05-23 21:30:43 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.point2d< / span > < span class = "kn" > import< / span > < span class = "n" > Point2d< / span >
2023-07-08 01:08:27 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.point3d< / span > < span class = "kn" > import< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
< span class = "kn" > from< / span > < span class = "nn" > ..models.scene_selection_type< / span > < span class = "kn" > import< / span > < span class = "n" > SceneSelectionType< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< 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 new path." " " < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > path< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > to< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " move_path_pen" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " move_path_pen" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > path< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > segment< / span > < span class = "p" > :< / span > < span class = "n" > PathSegment< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Command for extruding a solid 2d." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > cap< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< span class = "n" > distance< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
2023-05-04 00:58:06 -07:00
2023-12-05 16:25:51 -08:00
< span class = "n" > target< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " extrude" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " extrude" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Command for revolving a solid 2d." " " < / span >
< span class = "n" > angle< / span > < span class = "p" > :< / span > < span class = "n" > Angle< / span >
< span class = "n" > axis< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "n" > axis_is_2d< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
< span class = "n" > origin< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "n" > target< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
< span class = "n" > tolerance< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " revolve" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " revolve" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Command for revolving a solid 2d." " " < / 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" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > shell_thickness< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_shell_face" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_shell_face" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Command for revolving a solid 2d about a brep edge" " " < / span >
< span class = "n" > angle< / span > < span class = "p" > :< / span > < span class = "n" > Angle< / span >
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > target< / span > < span class = "p" > :< / span > < span class = "n" > ModelingCmdId< / span >
< span class = "n" > tolerance< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " revolve_about_edge" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " revolve_about_edge" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Closes a path, converting it to a 2D solid." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > path_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " close_path" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " close_path" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Camera drag started." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > interaction< / span > < span class = "p" > :< / span > < span class = "n" > CameraDragInteractionType< / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > window< / span > < span class = "p" > :< / span > < span class = "n" > Point2d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Camera drag continued." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > interaction< / span > < span class = "p" > :< / span > < span class = "n" > CameraDragInteractionType< / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > interaction< / span > < span class = "p" > :< / span > < span class = "n" > CameraDragInteractionType< / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Gets the default camera' s camera settings" " " < / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " default_camera_get_settings" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " default_camera_get_settings" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Change what the default camera is looking at." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > center< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > up< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > vantage< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Change what the default camera is looking at." " " < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > center< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " default_camera_perspective_settings" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
< span class = "s2" > " default_camera_perspective_settings" < / span >
< span class = "p" > )< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > up< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > vantage< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > magnitude< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Export the scene to a file." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "nb" > format< / span > < span class = "p" > :< / span > < span class = "n" > OutputFormat< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " What is this entity' s parent?" " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_get_parent_id" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_get_parent_id" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " How many children does the entity have?" " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " What is the UUID of this entity' s n-th child?" " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > child_index< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_get_child_uuid" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_get_child_uuid" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " What are all UUIDs of this entity' s children?" " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_get_all_child_uuids" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_get_all_child_uuids" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " What are all UUIDs of all the paths sketched on top of this entity?" " " < / span >
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_get_sketch_paths" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_get_sketch_paths" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " What is the distance between these two entities?" " " < / span >
< span class = "n" > distance_type< / span > < span class = "p" > :< / span > < span class = "n" > DistanceType< / span >
< span class = "n" > entity_id1< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > entity_id2< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_get_distance" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_get_distance" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Create a pattern using this entity by specifying the transform for each desired repetition." " " < / 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" > " entity_linear_pattern_transform" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_linear_pattern_transform" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Create a linear pattern using this entity." " " < / span >
< span class = "n" > axis< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > num_repetitions< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
< span class = "n" > spacing< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_linear_pattern" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_linear_pattern" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Create a circular pattern using this entity." " " < / span >
< span class = "n" > arc_degrees< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
< span class = "n" > axis< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "n" > center< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > num_repetitions< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
< span class = "n" > rotate_duplicates< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_circular_pattern" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_circular_pattern" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Create a helix using the input cylinder and other specified parameters." " " < / span >
< span class = "n" > cylinder_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > is_clockwise< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
< span class = "n" > length< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "n" > revolutions< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
< span class = "n" > start_angle< / span > < span class = "p" > :< / span > < span class = "n" > Angle< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_make_helix" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_make_helix" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Mirror the input entities over the specified axis. (Currently only supports sketches)" " " < / span >
< span class = "n" > axis< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "n" > ids< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span >
< span class = "n" > point< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_mirror" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_mirror" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Mirror the input entities over the specified edge. (Currently only supports sketches)" " " < / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "n" > ids< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_mirror_across_edge" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_mirror_across_edge" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Enter edit mode" " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > target< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > selected_at_window< / span > < span class = "p" > :< / span > < span class = "n" > Point2d< / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > selection_type< / span > < span class = "p" > :< / span > < span class = "n" > SceneSelectionType< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Adds one or more entities (by UUID) to the selection." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Removes one or more entities (by UUID) from the selection." " " < / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Removes all of the Objects in the scene" " " < / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " scene_clear_all" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " scene_clear_all" < / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Replaces current selection with these entities (by UUID)." " " < / span >
< span class = "n" > entities< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "nb" > str< / span > < span class = "p" > ]< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " select_replace" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " select_replace" < / span >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > selected_at_window< / span > < span class = "p" > :< / span > < span class = "n" > Point2d< / span >
2023-07-08 01:08:27 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " highlight_set_entity" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " highlight_set_entity" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-08 01:08:27 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Changes the current highlighted entity to these entities." " " < / span >
2023-05-04 00:58:06 -07:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " highlight_set_entities" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " highlight_set_entities" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-05-04 00:58:06 -07:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Create a new annotation" " " < / span >
2023-05-04 00:58:06 -07:00
2023-12-05 16:25:51 -08:00
< span class = "n" > annotation_type< / span > < span class = "p" > :< / span > < span class = "n" > AnnotationType< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > clobber< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > options< / span > < span class = "p" > :< / span > < span class = "n" > AnnotationOptions< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " new_annotation" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " new_annotation" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Update an annotation" " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > annotation_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > options< / span > < span class = "p" > :< / span > < span class = "n" > AnnotationOptions< / span >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Changes visibility of scene-wide edge lines on brep solids" " " < / span >
< span class = "n" > hidden< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " edge_lines_visible" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " edge_lines_visible" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Hide or show an object" " " < / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > hidden< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " object_visible" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " object_visible" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Bring an object to the front of the scene" " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Set the material properties of an object" " " < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > ambient_occlusion< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > color< / span > < span class = "p" > :< / span > < span class = "n" > Color< / span >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > metalness< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > roughness< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " object_set_material_params_pbr" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " object_set_material_params_pbr" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
< 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 >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Gets all faces which use the given edge." " " < / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_get_all_edge_faces" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_get_all_edge_faces" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-31 19:56:37 +00:00
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Gets all edges which are opposite the given edge, across all possible faces." " " < / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-31 19:56:37 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-07-31 19:56:37 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_get_all_opposite_edges" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_get_all_opposite_edges" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-07-31 19:56:37 +00:00
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Gets the edge opposite the given edge, along the given face." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > face_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_get_opposite_edge" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_get_opposite_edge" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Gets the next adjacent edge for the given edge, along the given face." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > face_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Gets the previous adjacent edge for the given edge, along the given face." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > face_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_get_prev_adjacent_edge" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_get_prev_adjacent_edge" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Fillets the given edge with the specified radius." " " < / span >
< span class = "n" > cut_type< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > CutType< / 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 = "n" > radius< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "n" > tolerance< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_fillet_edge" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_fillet_edge" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Determines whether a brep face is planar and returns its surface-local planar axes if so" " " < / span >
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " face_is_planar" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " face_is_planar" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Determines a position on a brep face evaluated by parameters u,v" " " < / span >
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " face_get_position" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " face_get_position" < / span >
< span class = "n" > uv< / span > < span class = "p" > :< / span > < span class = "n" > Point2d< / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Obtains the surface \" center of mass\" " " " < / span >
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " face_get_center" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " face_get_center" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Determines the gradient (dFdu, dFdv) + normal vector on a brep face evaluated by parameters u,v" " " < / span >
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " face_get_gradient" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " face_get_gradient" < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > uv< / span > < span class = "p" > :< / span > < span class = "n" > Point2d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Send object to front or back." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > front< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " send_object" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " send_object" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Set opacity of the entity." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > opacity< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " entity_set_opacity" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " entity_set_opacity" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 entity in or out." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > fade_in< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 new plane" " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > clobber< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > origin< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > size< / span > < span class = "p" > :< / span > < span class = "n" > LengthUnit< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > x_axis< / span > < span class = "p" > :< / span > < span class = "n" > Point3d< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 color of a plane." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > color< / span > < span class = "p" > :< / span > < span class = "n" > Color< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > plane_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 current tool." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > tool< / span > < span class = "p" > :< / span > < span class = "n" > SceneToolType< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_tool" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_tool" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Disable sketch mode. If you are sketching on a face, be sure to not disable sketch mode until you have extruded. Otherwise, your object will not be fused with the face." " " < / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " sketch_mode_disable" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " sketch_mode_disable" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 for sketch mode." " " < / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " get_sketch_mode_plane" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " get_sketch_mode_plane" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Get the plane for sketch mode." " " < / span >
< span class = "n" > constraint_bound< / span > < span class = "p" > :< / span > < span class = "n" > PathComponentConstraintBound< / span >
< span class = "n" > constraint_type< / span > < span class = "p" > :< / span > < span class = "n" > PathComponentConstraintType< / span >
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " curve_set_constraint" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " curve_set_constraint" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Sketch on some entity (e.g. a plane, a face)." " " < / span >
< span class = "n" > adjust_camera< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > animated< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > entity_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > ortho< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > planar_normal< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > Point3d< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " enable_sketch_mode" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " enable_sketch_mode" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Set the background color of the scene." " " < / span >
< span class = "n" > color< / span > < span class = "p" > :< / span > < span class = "n" > Color< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_background_color" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_background_color" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Set the properties of the tool lines for the scene." " " < / span >
< span class = "n" > color< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > Color< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_current_tool_properties" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_current_tool_properties" < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Set the default system properties used when a specific property isn' t set." " " < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_default_system_properties" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_default_system_properties" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 the given curve." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > curve_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 the given curve." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > curve_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " curve_get_control_points" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " curve_get_control_points" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 of the current view." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "nb" > format< / span > < span class = "p" > :< / span > < span class = "n" > ImageFormat< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " take_snapshot" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " take_snapshot" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Add a gizmo showing the axes." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > clobber< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > gizmo_mode< / span > < span class = "p" > :< / span > < span class = "nb" > bool< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " make_axes_gizmo" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " make_axes_gizmo" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > path_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " path_get_info" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " path_get_info" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Obtain curve ids for vertex ids" " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > path_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " path_get_curve_uuids_for_vertices" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "p" > (< / span >
2023-12-05 16:25:51 -08:00
< span class = "s2" > " path_get_curve_uuids_for_vertices" < / span >
2024-07-28 22:52:47 +00:00
< 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" > " " " Obtain curve id by index" " " < / span >
< span class = "n" > index< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
< span class = "n" > path_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " path_get_curve_uuid" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " path_get_curve_uuid" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Obtain vertex ids for a path" " " < / span >
< span class = "n" > path_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " path_get_vertex_uuids" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " path_get_vertex_uuids" < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Obtain the sketch target id (if the path was drawn in sketchmode) for a path" " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > path_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " path_get_sketch_target_uuid" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " path_get_sketch_target_uuid" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 the mouse." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 the mouse." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 the mouse." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Remove scene objects." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " remove_scene_objects" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " remove_scene_objects" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > plane_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Find the start and end of a curve." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > curve_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Reconfigure the stream." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > fps< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > height< / span > < span class = "p" > :< / span > < span class = "nb" > int< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Import files to the current model." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "nb" > format< / span > < span class = "p" > :< / span > < span class = "n" > InputFormat< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " import_files" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " import_files" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " Set the units of the scene. For all following commands, the units will be interpreted as the given units." " " < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_scene_units" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_scene_units" < / span >
< span class = "n" > unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitLength< / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Get the mass of entities in the scene or the default scene." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > material_density< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > material_density_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitDensity< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > output_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitMass< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " mass" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " mass" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Get the density of entities in the scene or the default scene." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > material_mass< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > material_mass_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitMass< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > output_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitDensity< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " density" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " density" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Get the volume of entities in the scene or the default scene." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > output_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitVolume< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Get the center of mass of entities in the scene or the default scene." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > output_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitLength< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " center_of_mass" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " center_of_mass" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< span class = "w" > < / span > < span class = "sd" > " " " Get the surface area of entities in the scene or the default scene." " " < / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > output_unit< / span > < span class = "p" > :< / span > < span class = "n" > UnitArea< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 the default camera upon an object in the scene." " " < / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "n" > uuid< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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 >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< 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" > " " " When you select some entity with the current tool, what should happen to the entity?" " " < / span >
< span class = "n" > selection_type< / span > < span class = "p" > :< / span > < span class = "n" > SceneSelectionType< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_selection_type" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_selection_type" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " What kind of entities can be selected?" " " < / span >
< span class = "nb" > filter< / span > < span class = "p" > :< / span > < span class = "n" > List< / span > < span class = "p" > [< / span > < span class = "n" > EntityType< / span > < span class = "p" > ]< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " set_selection_filter" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " set_selection_filter" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Use orthographic projection." " " < / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " default_camera_set_orthographic" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " default_camera_set_orthographic" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Use perspective projection." " " < / span >
< span class = "n" > parameters< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / span > < span class = "p" > [< / span > < span class = "n" > PerspectiveCameraParameters< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " default_camera_set_perspective" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " default_camera_set_perspective" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Fit the view to the specified object(s)." " " < / span >
< span class = "n" > object_ids< / span > < span class = "p" > :< / span > < span class = "n" > Optional< / 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 = "kc" > None< / span >
< span class = "n" > padding< / span > < span class = "p" > :< / span > < span class = "nb" > float< / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " zoom_to_fit" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " zoom_to_fit" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Fit the view to the scene with an isometric view." " " < / span >
< span class = "n" > padding< / 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 = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " view_isometric" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " view_isometric" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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" > " " " Get a concise description of all of an extrusion' s faces." " " < / span >
< span class = "n" > edge_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< span class = "n" > object_id< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span >
2023-08-16 23:39:29 +00:00
2024-07-28 22:52:47 +00:00
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " solid3d_get_extrusion_face_info" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " solid3d_get_extrusion_face_info" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
< 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" > " " " Clear the selection" " " < / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " select_clear" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " select_clear" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
< div class = "viewcode-block" id = "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 >
< 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" > " " " Get the number of objects in the scene" " " < / span >
< span class = "nb" > type< / span > < span class = "p" > :< / span > < span class = "n" > Literal< / span > < span class = "p" > [< / span > < span class = "s2" > " get_num_objects" < / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "s2" > " get_num_objects" < / span >
< span class = "n" > model_config< / span > < span class = "o" > =< / span > < span class = "n" > ConfigDict< / span > < span class = "p" > (< / span > < span class = "n" > protected_namespaces< / span > < span class = "o" > =< / span > < span class = "p" > ())< / span > < / div >
2023-08-16 23:39:29 +00:00
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< span class = "n" > default_camera_get_settings< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< span class = "n" > default_camera_look_at< / span > < span class = "p" > ,< / span >
2024-07-28 22:52:47 +00:00
< span class = "n" > default_camera_perspective_settings< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< span class = "n" > scene_clear_all< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< span class = "n" > edge_lines_visible< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< span class = "n" > object_visible< / span > < span class = "p" > ,< / span >
< span class = "n" > object_bring_to_front< / span > < span class = "p" > ,< / span >
2024-07-28 22:52:47 +00:00
< span class = "n" > object_set_material_params_pbr< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< span class = "n" > get_entity_type< / span > < span class = "p" > ,< / span >
< span class = "n" > solid3d_get_all_edge_faces< / span > < span class = "p" > ,< / span >
2024-07-28 22:52:47 +00:00
< span class = "n" > solid2d_add_hole< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< span class = "n" > path_get_curve_uuid< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< span class = "n" > path_get_vertex_uuids< / span > < span class = "p" > ,< / span >
2024-07-28 22:52:47 +00:00
< span class = "n" > path_get_sketch_target_uuid< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< span class = "n" > set_scene_units< / span > < span class = "p" > ,< / span >
2023-12-05 16:25:51 -08:00
< 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 >
2024-07-28 22:52:47 +00:00
< 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 >
2023-12-05 16:25:51 -08:00
< 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 >
2023-07-08 01:08:27 +00:00
< span class = "p" > ]< / span >
2023-05-04 00:58:06 -07:00
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
2024-07-28 22:52:47 +00:00
< p > © Copyright 2024, KittyCAD Team Members.< / p >
2023-05-04 00:58:06 -07:00
< / 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 >
