156 lines
		
	
	
		
			4.7 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			156 lines
		
	
	
		
			4.7 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
---
 | 
						|
title: "KCL Standard Library"
 | 
						|
excerpt: "Documentation for the KCL standard library for the Zoo Design Studio."
 | 
						|
layout: manual
 | 
						|
---
 | 
						|
 | 
						|
## Table of Contents
 | 
						|
 | 
						|
### Language
 | 
						|
 | 
						|
* [`Types`](kcl/types)
 | 
						|
* [`Modules`](kcl/modules)
 | 
						|
* [`Settings`](kcl/settings)
 | 
						|
* [`Known Issues`](kcl/known-issues)
 | 
						|
* [`Constants`](kcl/consts)
 | 
						|
 | 
						|
### Standard library
 | 
						|
 | 
						|
* **Primitive types**
 | 
						|
  * [`bool`](kcl/types/bool)
 | 
						|
  * [`number`](kcl/types/number)
 | 
						|
  * [`string`](kcl/types/string)
 | 
						|
  * [`tag`](kcl/types/tag)
 | 
						|
* **std**
 | 
						|
  * [`Axis2d`](kcl/types/Axis2d)
 | 
						|
  * [`Axis3d`](kcl/types/Axis3d)
 | 
						|
  * [`END`](kcl/consts/std-END)
 | 
						|
  * [`Edge`](kcl/types/Edge)
 | 
						|
  * [`Face`](kcl/types/Face)
 | 
						|
  * [`Helix`](kcl/types/Helix)
 | 
						|
  * [`Plane`](kcl/types/Plane)
 | 
						|
  * [`Point2d`](kcl/types/Point2d)
 | 
						|
  * [`Point3d`](kcl/types/Point3d)
 | 
						|
  * [`START`](kcl/consts/std-START)
 | 
						|
  * [`Sketch`](kcl/types/Sketch)
 | 
						|
  * [`Solid`](kcl/types/Solid)
 | 
						|
  * [`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)
 | 
						|
  * [`abs`](kcl/abs)
 | 
						|
  * [`acos`](kcl/acos)
 | 
						|
  * [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
 | 
						|
  * [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
 | 
						|
  * [`angledLine`](kcl/angledLine)
 | 
						|
  * [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
 | 
						|
  * [`appearance`](kcl/appearance)
 | 
						|
  * [`arc`](kcl/arc)
 | 
						|
  * [`arcTo`](kcl/arcTo)
 | 
						|
  * [`asin`](kcl/asin)
 | 
						|
  * [`assert`](kcl/assert)
 | 
						|
  * [`assertEqual`](kcl/assertEqual)
 | 
						|
  * [`assertGreaterThan`](kcl/assertGreaterThan)
 | 
						|
  * [`assertGreaterThanOrEq`](kcl/assertGreaterThanOrEq)
 | 
						|
  * [`assertLessThan`](kcl/assertLessThan)
 | 
						|
  * [`assertLessThanOrEq`](kcl/assertLessThanOrEq)
 | 
						|
  * [`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)
 | 
						|
  * [`fromCm`](kcl/fromCm)
 | 
						|
  * [`fromFt`](kcl/fromFt)
 | 
						|
  * [`fromInches`](kcl/fromInches)
 | 
						|
  * [`fromM`](kcl/fromM)
 | 
						|
  * [`fromMm`](kcl/fromMm)
 | 
						|
  * [`fromYd`](kcl/fromYd)
 | 
						|
  * [`getCommonEdge`](kcl/getCommonEdge)
 | 
						|
  * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
 | 
						|
  * [`getOppositeEdge`](kcl/getOppositeEdge)
 | 
						|
  * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
 | 
						|
  * [`helix`](kcl/std-helix)
 | 
						|
  * [`hole`](kcl/hole)
 | 
						|
  * [`hollow`](kcl/hollow)
 | 
						|
  * [`intersect`](kcl/intersect)
 | 
						|
  * [`involuteCircular`](kcl/involuteCircular)
 | 
						|
  * [`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)
 | 
						|
  * [`revolve`](kcl/std-revolve)
 | 
						|
  * [`rotate`](kcl/rotate)
 | 
						|
  * [`round`](kcl/round)
 | 
						|
  * [`scale`](kcl/scale)
 | 
						|
  * [`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)
 | 
						|
  * [`subtract`](kcl/subtract)
 | 
						|
  * [`sweep`](kcl/sweep)
 | 
						|
  * [`tangentToEnd`](kcl/tangentToEnd)
 | 
						|
  * [`tangentialArc`](kcl/tangentialArc)
 | 
						|
  * [`toDegrees`](kcl/toDegrees)
 | 
						|
  * [`toRadians`](kcl/toRadians)
 | 
						|
  * [`translate`](kcl/translate)
 | 
						|
  * [`union`](kcl/union)
 | 
						|
  * [`xLine`](kcl/xLine)
 | 
						|
  * [`yLine`](kcl/yLine)
 | 
						|
* **std::math**
 | 
						|
  * [`E`](kcl/consts/std-math-E)
 | 
						|
  * [`PI`](kcl/consts/std-math-PI)
 | 
						|
  * [`TAU`](kcl/consts/std-math-TAU)
 | 
						|
  * [`cos`](kcl/std-math-cos)
 | 
						|
  * [`polar`](kcl/std-math-polar)
 | 
						|
  * [`sin`](kcl/std-math-sin)
 | 
						|
  * [`tan`](kcl/std-math-tan)
 | 
						|
* **std::sketch**
 | 
						|
  * [`circle`](kcl/std-sketch-circle)
 | 
						|
  * [`mirror2d`](kcl/std-sketch-mirror2d)
 | 
						|
* **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)
 |