2024-03-13 14:22:22 -07:00
|
|
|
---
|
|
|
|
title: "KCL Standard Library"
|
2025-04-03 22:24:51 -04:00
|
|
|
excerpt: "Documentation for the KCL standard library for the Zoo Design Studio."
|
2024-03-13 14:22:22 -07:00
|
|
|
layout: manual
|
|
|
|
---
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
2025-02-27 09:34:55 +13:00
|
|
|
### Language
|
|
|
|
|
|
|
|
* [`Types`](kcl/types)
|
|
|
|
* [`Modules`](kcl/modules)
|
|
|
|
* [`Settings`](kcl/settings)
|
|
|
|
* [`Known Issues`](kcl/known-issues)
|
2025-03-11 11:44:27 -07:00
|
|
|
* [`Constants`](kcl/consts)
|
2025-02-27 09:34:55 +13:00
|
|
|
|
|
|
|
### Standard library
|
|
|
|
|
2025-03-08 03:53:34 +13:00
|
|
|
* **Primitive types**
|
2025-03-11 11:44:27 -07:00
|
|
|
* [`bool`](kcl/types/bool)
|
|
|
|
* [`number`](kcl/types/number)
|
|
|
|
* [`string`](kcl/types/string)
|
|
|
|
* [`tag`](kcl/types/tag)
|
2025-03-08 03:53:34 +13:00
|
|
|
* **std**
|
2025-04-14 20:37:45 +12:00
|
|
|
* [`END`](kcl/consts/std-END)
|
|
|
|
* [`START`](kcl/consts/std-START)
|
2025-04-03 22:44:52 +13:00
|
|
|
* [`X`](kcl/consts/std-X)
|
2025-03-11 11:44:27 -07:00
|
|
|
* [`XY`](kcl/consts/std-XY)
|
|
|
|
* [`XZ`](kcl/consts/std-XZ)
|
2025-04-03 22:44:52 +13:00
|
|
|
* [`Y`](kcl/consts/std-Y)
|
2025-03-11 11:44:27 -07:00
|
|
|
* [`YZ`](kcl/consts/std-YZ)
|
2025-04-03 22:44:52 +13:00
|
|
|
* [`Z`](kcl/consts/std-Z)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`abs`](kcl/abs)
|
|
|
|
* [`acos`](kcl/acos)
|
|
|
|
* [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
|
|
|
|
* [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
|
|
|
|
* [`angledLine`](kcl/angledLine)
|
|
|
|
* [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
|
|
|
|
* [`appearance`](kcl/appearance)
|
|
|
|
* [`arc`](kcl/arc)
|
|
|
|
* [`asin`](kcl/asin)
|
|
|
|
* [`assert`](kcl/assert)
|
2025-04-22 12:44:52 -05:00
|
|
|
* [`assertIs`](kcl/assertIs)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`atan`](kcl/atan)
|
|
|
|
* [`atan2`](kcl/atan2)
|
|
|
|
* [`bezierCurve`](kcl/bezierCurve)
|
|
|
|
* [`ceil`](kcl/ceil)
|
|
|
|
* [`chamfer`](kcl/chamfer)
|
|
|
|
* [`circleThreePoint`](kcl/circleThreePoint)
|
|
|
|
* [`close`](kcl/close)
|
|
|
|
* [`extrude`](kcl/extrude)
|
|
|
|
* [`fillet`](kcl/fillet)
|
|
|
|
* [`floor`](kcl/floor)
|
2025-03-19 15:12:27 -07:00
|
|
|
* [`getCommonEdge`](kcl/getCommonEdge)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
|
|
|
|
* [`getOppositeEdge`](kcl/getOppositeEdge)
|
|
|
|
* [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
|
2025-04-03 22:44:52 +13:00
|
|
|
* [`helix`](kcl/std-helix)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`hole`](kcl/hole)
|
|
|
|
* [`hollow`](kcl/hollow)
|
2025-04-10 18:30:57 -07:00
|
|
|
* [`intersect`](kcl/intersect)
|
2025-04-11 21:59:11 +01:00
|
|
|
* [`involuteCircular`](kcl/involuteCircular)
|
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)
|
|
|
|
* [`ln`](kcl/ln)
|
|
|
|
* [`loft`](kcl/loft)
|
|
|
|
* [`log`](kcl/log)
|
|
|
|
* [`log10`](kcl/log10)
|
|
|
|
* [`log2`](kcl/log2)
|
|
|
|
* [`map`](kcl/map)
|
|
|
|
* [`max`](kcl/max)
|
|
|
|
* [`min`](kcl/min)
|
|
|
|
* [`offsetPlane`](kcl/offsetPlane)
|
|
|
|
* [`patternCircular2d`](kcl/patternCircular2d)
|
|
|
|
* [`patternCircular3d`](kcl/patternCircular3d)
|
|
|
|
* [`patternLinear2d`](kcl/patternLinear2d)
|
|
|
|
* [`patternLinear3d`](kcl/patternLinear3d)
|
|
|
|
* [`patternTransform`](kcl/patternTransform)
|
|
|
|
* [`patternTransform2d`](kcl/patternTransform2d)
|
|
|
|
* [`polygon`](kcl/polygon)
|
|
|
|
* [`pop`](kcl/pop)
|
|
|
|
* [`pow`](kcl/pow)
|
|
|
|
* [`profileStart`](kcl/profileStart)
|
|
|
|
* [`profileStartX`](kcl/profileStartX)
|
|
|
|
* [`profileStartY`](kcl/profileStartY)
|
|
|
|
* [`push`](kcl/push)
|
|
|
|
* [`reduce`](kcl/reduce)
|
|
|
|
* [`rem`](kcl/rem)
|
2025-04-03 22:44:52 +13:00
|
|
|
* [`revolve`](kcl/std-revolve)
|
2025-02-26 16:45:19 -08:00
|
|
|
* [`rotate`](kcl/rotate)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`round`](kcl/round)
|
2025-02-26 16:45:19 -08:00
|
|
|
* [`scale`](kcl/scale)
|
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)
|
|
|
|
* [`shell`](kcl/shell)
|
|
|
|
* [`sqrt`](kcl/sqrt)
|
|
|
|
* [`startProfileAt`](kcl/startProfileAt)
|
|
|
|
* [`startSketchOn`](kcl/startSketchOn)
|
2025-04-10 18:30:57 -07:00
|
|
|
* [`subtract`](kcl/subtract)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`sweep`](kcl/sweep)
|
|
|
|
* [`tangentToEnd`](kcl/tangentToEnd)
|
|
|
|
* [`tangentialArc`](kcl/tangentialArc)
|
2025-04-23 10:58:35 +12:00
|
|
|
* [`toCentimeters`](kcl/std-toCentimeters)
|
|
|
|
* [`toDegrees`](kcl/std-toDegrees)
|
|
|
|
* [`toFeet`](kcl/std-toFeet)
|
|
|
|
* [`toInches`](kcl/std-toInches)
|
|
|
|
* [`toMeters`](kcl/std-toMeters)
|
|
|
|
* [`toMillimeters`](kcl/std-toMillimeters)
|
|
|
|
* [`toRadians`](kcl/std-toRadians)
|
|
|
|
* [`toYards`](kcl/std-toYards)
|
2025-02-26 16:45:19 -08:00
|
|
|
* [`translate`](kcl/translate)
|
2025-04-10 18:30:57 -07:00
|
|
|
* [`union`](kcl/union)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`xLine`](kcl/xLine)
|
|
|
|
* [`yLine`](kcl/yLine)
|
2025-03-08 03:53:34 +13:00
|
|
|
* **std::math**
|
2025-03-11 11:44:27 -07:00
|
|
|
* [`E`](kcl/consts/std-math-E)
|
|
|
|
* [`PI`](kcl/consts/std-math-PI)
|
|
|
|
* [`TAU`](kcl/consts/std-math-TAU)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`cos`](kcl/std-math-cos)
|
2025-04-08 08:16:43 +12:00
|
|
|
* [`polar`](kcl/std-math-polar)
|
2025-02-20 19:33:21 +13:00
|
|
|
* [`sin`](kcl/std-math-sin)
|
|
|
|
* [`tan`](kcl/std-math-tan)
|
2025-03-24 21:55:24 +13:00
|
|
|
* **std::sketch**
|
|
|
|
* [`circle`](kcl/std-sketch-circle)
|
2025-04-03 22:44:52 +13:00
|
|
|
* [`mirror2d`](kcl/std-sketch-mirror2d)
|
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)
|
2025-04-22 11:00:53 +12:00
|
|
|
* **std::types**
|
|
|
|
* [`Axis2d`](kcl/types/Axis2d)
|
|
|
|
* [`Axis3d`](kcl/types/Axis3d)
|
|
|
|
* [`Edge`](kcl/types/Edge)
|
|
|
|
* [`Face`](kcl/types/Face)
|
|
|
|
* [`Helix`](kcl/types/Helix)
|
|
|
|
* [`Plane`](kcl/types/Plane)
|
|
|
|
* [`Point2d`](kcl/types/Point2d)
|
|
|
|
* [`Point3d`](kcl/types/Point3d)
|
|
|
|
* [`Sketch`](kcl/types/Sketch)
|
|
|
|
* [`Solid`](kcl/types/Solid)
|