ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4fe8741ea72600001da6593f3a8358c695c37b51
modeling-app/docs/kcl/index.md

168 lines
5.6 KiB
Markdown
Raw Normal View History

change up docs format (#1711) * change up docs format Signed-off-by: Jess Frazelle <github@jessfraz.com> * change up docs format Signed-off-by: Jess Frazelle <github@jessfraz.com> * change up docs format Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * workflow to push docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix[ Signed-off-by: Jess Frazelle <github@jessfraz.com> * initial commit Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * initial commit Signed-off-by: Jess Frazelle <github@jessfraz.com> * initial commit Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2024-03-13 14:22:22 -07:00
---
title: "KCL Standard Library"
Rename the app to Zoo Design Studio (#5974) * WIP: Change the name of the app Fixes #5971 * Force release build * More renames * Fix release builds on PR * Remove alpha on home page, replace with nightly if nightly * Change appId back to dev.zoo.modeling-app after updater test failure * Cleanup towards review * Lint * Lint plus @jacebrowning's suggestion * Lint
2025-04-03 22:24:51 -04:00
excerpt: "Documentation for the KCL standard library for the Zoo Design Studio."
change up docs format (#1711) * change up docs format Signed-off-by: Jess Frazelle <github@jessfraz.com> * change up docs format Signed-off-by: Jess Frazelle <github@jessfraz.com> * change up docs format Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * workflow to push docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix[ Signed-off-by: Jess Frazelle <github@jessfraz.com> * initial commit Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix Signed-off-by: Jess Frazelle <github@jessfraz.com> * initial commit Signed-off-by: Jess Frazelle <github@jessfraz.com> * initial commit Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2024-03-13 14:22:22 -07:00
layout: manual
---
## Table of Contents
Test code examples in docs and add docs for per-file settings (#5474) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-02-27 09:34:55 +13:00
### Language
* [`Types`](kcl/types)
* [`Modules`](kcl/modules)
* [`Settings`](kcl/settings)
* [`Known Issues`](kcl/known-issues)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
### Functions
Test code examples in docs and add docs for per-file settings (#5474) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-02-27 09:34:55 +13:00
Support types in the standard library (#5651) * Parse an unparse type decls (and refactor impl attributes slightly) Signed-off-by: Nick Cameron <nrc@ncameron.org> * Remove special treatment of geometric types from parser and executor Signed-off-by: Nick Cameron <nrc@ncameron.org> * Generate docs for std types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Hover tool-tips for types and fixup the frontend Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fixes Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-08 03:53:34 +13:00
* **std**
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`angledLine`](kcl/angledLine)
* [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
* [`appearance`](kcl/appearance)
* [`arc`](kcl/arc)
* [`assert`](kcl/assert)
Kwargs: assert functions (#6406) Closes https://github.com/KittyCAD/modeling-app/issues/6408
2025-04-22 12:44:52 -05:00
* [`assertIs`](kcl/assertIs)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`bezierCurve`](kcl/bezierCurve)
* [`circleThreePoint`](kcl/circleThreePoint)
Add clone (#5462) * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> update the extrude idds Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> fix sample Signed-off-by: Jess Frazelle <github@jessfraz.com> better docs Signed-off-by: Jess Frazelle <github@jessfraz.com> fix the start and end tag Signed-off-by: Jess Frazelle <github@jessfraz.com> better docs Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> new tests Signed-off-by: Jess Frazelle <github@jessfraz.com> codespell Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix examples Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix some stuff Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * add another test for fillet Signed-off-by: Jess Frazelle <github@jessfraz.com> * Update rust/kcl-lib/src/std/clone.rs Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * add sweep test Signed-off-by: Jess Frazelle <github@jessfraz.com> * revolve test; Signed-off-by: Jess Frazelle <github@jessfraz.com> * Update rust/kcl-lib/src/std/clone.rs Co-authored-by: Jonathan Tran <jonnytran@gmail.com> * add another test for fillet Signed-off-by: Jess Frazelle <github@jessfraz.com> * allow cloning an imported geometry; Signed-off-by: Jess Frazelle <github@jessfraz.com> * allow for imported geometry Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * update docs Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> Co-authored-by: Jonathan Tran <jonnytran@gmail.com>
2025-04-23 21:26:09 -07:00
* [`clone`](kcl/clone)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`close`](kcl/close)
* [`extrude`](kcl/extrude)
get common edge (#5869) * get common edge Signed-off-by: Jess Frazelle <github@jessfraz.com> * fmt Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * add get common edge Signed-off-by: Jess Frazelle <github@jessfraz.com> * docs Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-03-19 15:12:27 -07:00
* [`getCommonEdge`](kcl/getCommonEdge)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
* [`getOppositeEdge`](kcl/getOppositeEdge)
* [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
* [`helix`](kcl/functions/std-helix)
Bump modeling api & pull thru csg endpoints (#6245) * csg-upts Signed-off-by: Jess Frazelle <github@jessfraz.com> * base Signed-off-by: Jess Frazelle <github@jessfraz.com> * do the id shit Signed-off-by: Jess Frazelle <github@jessfraz.com> * tried to run Signed-off-by: Jess Frazelle <github@jessfraz.com> * csg-upts Signed-off-by: Jess Frazelle <github@jessfraz.com> * use bens samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * use bens samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix; Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-04-10 18:30:57 -07:00
* [`intersect`](kcl/intersect)
Involute curve for sketch (#6258) * WIP: Involute circles in KCL * first pass involute end calculation * fmt * cleanup * involute snapshot * actually update markdown * remove debug build stuff * spacing --------- Co-authored-by: Adam Chalmers <adam.chalmers@zoo.dev>
2025-04-11 21:59:11 +01:00
* [`involuteCircular`](kcl/involuteCircular)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`lastSegX`](kcl/lastSegX)
* [`lastSegY`](kcl/lastSegY)
* [`legAngX`](kcl/legAngX)
* [`legAngY`](kcl/legAngY)
* [`legLen`](kcl/legLen)
* [`line`](kcl/line)
* [`loft`](kcl/loft)
* [`map`](kcl/map)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
* [`offsetPlane`](kcl/functions/std-offsetPlane)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`patternCircular2d`](kcl/patternCircular2d)
* [`patternCircular3d`](kcl/patternCircular3d)
* [`patternLinear2d`](kcl/patternLinear2d)
* [`patternLinear3d`](kcl/patternLinear3d)
* [`patternTransform`](kcl/patternTransform)
* [`patternTransform2d`](kcl/patternTransform2d)
* [`polygon`](kcl/polygon)
* [`pop`](kcl/pop)
* [`profileStart`](kcl/profileStart)
* [`profileStartX`](kcl/profileStartX)
* [`profileStartY`](kcl/profileStartY)
* [`push`](kcl/push)
* [`reduce`](kcl/reduce)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
* [`revolve`](kcl/functions/std-revolve)
Transform std lib functions (#5067) * transform Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * u[dates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-26 16:45:19 -08:00
* [`rotate`](kcl/rotate)
* [`scale`](kcl/scale)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`segAng`](kcl/segAng)
* [`segEnd`](kcl/segEnd)
* [`segEndX`](kcl/segEndX)
* [`segEndY`](kcl/segEndY)
* [`segLen`](kcl/segLen)
* [`segStart`](kcl/segStart)
* [`segStartX`](kcl/segStartX)
* [`segStartY`](kcl/segStartY)
Kwargs: startProfileAt (#6424) Previous: ``` startProfileAt([x, y], %) startProfileAt([x, y], sketch001) ``` New: ``` startProfile(%, at = [x, y]) startProfile(sketch001, at = [x, y]) ```
2025-04-25 16:01:35 -05:00
* [`startProfile`](kcl/startProfile)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`startSketchOn`](kcl/startSketchOn)
Bump modeling api & pull thru csg endpoints (#6245) * csg-upts Signed-off-by: Jess Frazelle <github@jessfraz.com> * base Signed-off-by: Jess Frazelle <github@jessfraz.com> * do the id shit Signed-off-by: Jess Frazelle <github@jessfraz.com> * tried to run Signed-off-by: Jess Frazelle <github@jessfraz.com> * csg-upts Signed-off-by: Jess Frazelle <github@jessfraz.com> * use bens samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * use bens samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix; Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-04-10 18:30:57 -07:00
* [`subtract`](kcl/subtract)
KCL: Migrate hole to kwargs (#6382) Previously: `|> hole(circle(radius = 2, center = p), %)` Now: `|> subtract2d(tool = circle(radius = 2, center = p))`
2025-04-26 15:31:51 -05:00
* [`subtract2d`](kcl/subtract2d)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`sweep`](kcl/sweep)
* [`tangentToEnd`](kcl/tangentToEnd)
* [`tangentialArc`](kcl/tangentialArc)
Transform std lib functions (#5067) * transform Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * u[dates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix tests Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-26 16:45:19 -08:00
* [`translate`](kcl/translate)
Bump modeling api & pull thru csg endpoints (#6245) * csg-upts Signed-off-by: Jess Frazelle <github@jessfraz.com> * base Signed-off-by: Jess Frazelle <github@jessfraz.com> * do the id shit Signed-off-by: Jess Frazelle <github@jessfraz.com> * tried to run Signed-off-by: Jess Frazelle <github@jessfraz.com> * csg-upts Signed-off-by: Jess Frazelle <github@jessfraz.com> * use bens samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * use bens samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix; Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-04-10 18:30:57 -07:00
* [`union`](kcl/union)
Declare parts of std in KCL rather than Rust (#5147) Declare std in KCL
2025-02-20 19:33:21 +13:00
* [`xLine`](kcl/xLine)
* [`yLine`](kcl/yLine)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
* **std::math**
* [`abs`](kcl/functions/std-math-abs)
* [`acos`](kcl/functions/std-math-acos)
* [`asin`](kcl/functions/std-math-asin)
* [`atan`](kcl/functions/std-math-atan)
* [`atan2`](kcl/functions/std-math-atan2)
* [`ceil`](kcl/functions/std-math-ceil)
* [`cos`](kcl/functions/std-math-cos)
* [`floor`](kcl/functions/std-math-floor)
* [`ln`](kcl/functions/std-math-ln)
* [`log`](kcl/functions/std-math-log)
* [`log10`](kcl/functions/std-math-log10)
* [`log2`](kcl/functions/std-math-log2)
* [`max`](kcl/functions/std-math-max)
* [`min`](kcl/functions/std-math-min)
* [`polar`](kcl/functions/std-math-polar)
* [`pow`](kcl/functions/std-math-pow)
* [`rem`](kcl/functions/std-math-rem)
* [`round`](kcl/functions/std-math-round)
* [`sin`](kcl/functions/std-math-sin)
* [`sqrt`](kcl/functions/std-math-sqrt)
* [`tan`](kcl/functions/std-math-tan)
* **std::sketch**
* [`circle`](kcl/functions/std-sketch-circle)
* [`mirror2d`](kcl/functions/std-sketch-mirror2d)
* **std::solid**
* [`chamfer`](kcl/functions/std-solid-chamfer)
* [`fillet`](kcl/functions/std-solid-fillet)
* [`hollow`](kcl/functions/std-solid-hollow)
* [`shell`](kcl/functions/std-solid-shell)
* **std::units**
* [`units::toCentimeters`](kcl/functions/std-units-toCentimeters)
* [`units::toDegrees`](kcl/functions/std-units-toDegrees)
* [`units::toFeet`](kcl/functions/std-units-toFeet)
* [`units::toInches`](kcl/functions/std-units-toInches)
* [`units::toMeters`](kcl/functions/std-units-toMeters)
* [`units::toMillimeters`](kcl/functions/std-units-toMillimeters)
* [`units::toRadians`](kcl/functions/std-units-toRadians)
* [`units::toYards`](kcl/functions/std-units-toYards)
### Constants
* **std**
* [`END`](kcl/consts/std-END)
* [`START`](kcl/consts/std-START)
* [`X`](kcl/consts/std-X)
* [`XY`](kcl/consts/std-XY)
* [`XZ`](kcl/consts/std-XZ)
* [`Y`](kcl/consts/std-Y)
* [`YZ`](kcl/consts/std-YZ)
* [`Z`](kcl/consts/std-Z)
Support types in the standard library (#5651) * Parse an unparse type decls (and refactor impl attributes slightly) Signed-off-by: Nick Cameron <nrc@ncameron.org> * Remove special treatment of geometric types from parser and executor Signed-off-by: Nick Cameron <nrc@ncameron.org> * Generate docs for std types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Hover tool-tips for types and fixup the frontend Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fixes Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-08 03:53:34 +13:00
* **std::math**
Add math functions back to the prelude (#6595) * Add math functions back to the prelude * Update output * Update docs
2025-04-30 11:07:05 -04:00
* [`E`](kcl/consts/std-math-E)
* [`PI`](kcl/consts/std-math-PI)
* [`TAU`](kcl/consts/std-math-TAU)
Move turns to a submodule of std (#6039) * Move turns to a submodule of std Signed-off-by: Nick Cameron <nrc@ncameron.org> * Cache module infos as well as memory; fix a bug with deprecated constants Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-30 11:10:44 +13:00
* **std::turns**
* [`turns::HALF_TURN`](kcl/consts/std-turns-HALF_TURN)
* [`turns::QUARTER_TURN`](kcl/consts/std-turns-QUARTER_TURN)
* [`turns::THREE_QUARTER_TURN`](kcl/consts/std-turns-THREE_QUARTER_TURN)
* [`turns::ZERO`](kcl/consts/std-turns-ZERO)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
### Types
See also the [types overview](types)
* **Primitive types**
Fix link to types.md in docs (#6653) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-03 04:06:43 +12:00
* [`End`](kcl/types#End)
* [`ImportedGeometry`](kcl/types#ImportedGeometry)
* [`Start`](kcl/types#Start)
* [`TagDeclarator`](kcl/types#TagDeclarator)
* [`TagIdentifier`](kcl/types#TagIdentifier)
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
* [`any`](kcl/types/std-types-any)
* [`bool`](kcl/types/std-types-bool)
* [`number`](kcl/types/std-types-number)
* [`string`](kcl/types/std-types-string)
* [`tag`](kcl/types/std-types-tag)
Coerce the result of a function call to the function's return type (#6309) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-04-22 11:00:53 +12:00
* **std::types**
Docs improvements (#6615) Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-02 03:56:27 +12:00
* [`Axis2d`](kcl/types/std-types-Axis2d)
* [`Axis3d`](kcl/types/std-types-Axis3d)
* [`Edge`](kcl/types/std-types-Edge)
* [`Face`](kcl/types/std-types-Face)
* [`Helix`](kcl/types/std-types-Helix)
* [`Plane`](kcl/types/std-types-Plane)
* [`Point2d`](kcl/types/std-types-Point2d)
* [`Point3d`](kcl/types/std-types-Point3d)
* [`Sketch`](kcl/types/std-types-Sketch)
* [`Solid`](kcl/types/std-types-Solid)
Reference in New Issue Copy Permalink