Add modules to docs (#6699)
* Support modules in docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * shuffle around directories Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
		
							
								
								
									
										5
									
								
								docs/kcl-std/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								docs/kcl-std/README.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,5 @@ | ||||
| # Autogenerated docs | ||||
|  | ||||
| Everything in this directory and its subdirectories (except this file) is automatically generated. Do not edit anything in this directory directly, your changes will be lost. | ||||
|  | ||||
| The directory contents are generated by running the `test_generate_stdlib_markdown_docs` test in `/rust/kcl-lib/src/docs/gen_std_tests.rs`. Files are generated from the standard library declared in KCL (`/rust/kcl-lib/std`) and in Rust (`/rust/kcl-lib/src/std`), and by copying files from `../kcl-src`. | ||||
							
								
								
									
										59
									
								
								docs/kcl-std/angledLine.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										59
									
								
								docs/kcl-std/angledLine.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										53
									
								
								docs/kcl-std/angledLineThatIntersects.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										53
									
								
								docs/kcl-std/angledLineThatIntersects.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										220
									
								
								docs/kcl-std/appearance.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										220
									
								
								docs/kcl-std/appearance.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										66
									
								
								docs/kcl-std/arc.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										66
									
								
								docs/kcl-std/arc.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										64
									
								
								docs/kcl-std/assert.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								docs/kcl-std/assert.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										40
									
								
								docs/kcl-std/assertIs.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								docs/kcl-std/assertIs.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										52
									
								
								docs/kcl-std/bezierCurve.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								docs/kcl-std/bezierCurve.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										47
									
								
								docs/kcl-std/circleThreePoint.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								docs/kcl-std/circleThreePoint.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										258
									
								
								docs/kcl-std/clone.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										258
									
								
								docs/kcl-std/clone.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										56
									
								
								docs/kcl-std/close.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								docs/kcl-std/close.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										33
									
								
								docs/kcl-std/consts.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								docs/kcl-std/consts.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,33 @@ | ||||
| --- | ||||
| title: "KCL Constants" | ||||
| excerpt: "Documentation for the KCL constants." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| ## Table of Contents | ||||
|  | ||||
|  | ||||
| ### `std` | ||||
|  | ||||
| - [`END`](/docs/kcl/consts/std-END) | ||||
| - [`START`](/docs/kcl/consts/std-START) | ||||
| - [`X`](/docs/kcl/consts/std-X) | ||||
| - [`XY`](/docs/kcl/consts/std-XY) | ||||
| - [`XZ`](/docs/kcl/consts/std-XZ) | ||||
| - [`Y`](/docs/kcl/consts/std-Y) | ||||
| - [`YZ`](/docs/kcl/consts/std-YZ) | ||||
| - [`Z`](/docs/kcl/consts/std-Z) | ||||
|  | ||||
| ### `std::math` | ||||
|  | ||||
| - [`E`](/docs/kcl/consts/std-math-E) | ||||
| - [`PI`](/docs/kcl/consts/std-math-PI) | ||||
| - [`TAU`](/docs/kcl/consts/std-math-TAU) | ||||
|  | ||||
| ### `std::turns` | ||||
|  | ||||
| - [`HALF_TURN`](/docs/kcl/consts/std-turns-HALF_TURN) | ||||
| - [`QUARTER_TURN`](/docs/kcl/consts/std-turns-QUARTER_TURN) | ||||
| - [`THREE_QUARTER_TURN`](/docs/kcl/consts/std-turns-THREE_QUARTER_TURN) | ||||
| - [`ZERO`](/docs/kcl/consts/std-turns-ZERO) | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-END.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-END.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::END" | ||||
| excerpt: "Identifies the ending face of an extrusion. I.e., the new face created by an extrusion." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Identifies the ending face of an extrusion. I.e., the new face created by an extrusion. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::END: string = 'end' | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-START.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-START.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::START" | ||||
| excerpt: "Identifies the starting face of an extrusion. I.e., the face which is extruded." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Identifies the starting face of an extrusion. I.e., the face which is extruded. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::START: string = 'start' | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-X.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-X.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::X" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::X | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-XY.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-XY.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::XY" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::XY | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-XZ.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-XZ.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::XZ" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::XZ | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-Y.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-Y.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::Y" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::Y | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-YZ.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-YZ.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::YZ" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::YZ | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-Z.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-Z.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::Z" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::Z | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										32
									
								
								docs/kcl-std/consts/std-math-E.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								docs/kcl-std/consts/std-math-E.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										28
									
								
								docs/kcl-std/consts/std-math-PI.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								docs/kcl-std/consts/std-math-PI.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										32
									
								
								docs/kcl-std/consts/std-math-TAU.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								docs/kcl-std/consts/std-math-TAU.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-turns-HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-turns-HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::turns::HALF_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::turns::HALF_TURN: number(deg) = 180deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-turns-QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-turns-QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::turns::QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::turns::QUARTER_TURN: number(deg) = 90deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-turns-THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-turns-THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::turns::THREE_QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::turns::THREE_QUARTER_TURN: number(deg) = 270deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl-std/consts/std-turns-ZERO.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl-std/consts/std-turns-ZERO.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::turns::ZERO" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| std::turns::ZERO: number = 0 | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										104
									
								
								docs/kcl-std/extrude.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										104
									
								
								docs/kcl-std/extrude.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										124
									
								
								docs/kcl-std/functions/std-helix.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										124
									
								
								docs/kcl-std/functions/std-helix.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										51
									
								
								docs/kcl-std/functions/std-math-abs.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								docs/kcl-std/functions/std-math-abs.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										45
									
								
								docs/kcl-std/functions/std-math-acos.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								docs/kcl-std/functions/std-math-acos.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-asin.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-asin.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										43
									
								
								docs/kcl-std/functions/std-math-atan.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								docs/kcl-std/functions/std-math-atan.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,43 @@ | ||||
| --- | ||||
| title: "std::math::atan" | ||||
| excerpt: "Compute the arctangent of a number." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Compute the arctangent of a number. | ||||
|  | ||||
| Consider using `atan2()` instead for the true inverse of tangent. | ||||
|  | ||||
| ```kcl | ||||
| atan(@num: number(_)): number(rad) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(_)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(rad)` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| ```kcl | ||||
| sketch001 = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> angledLine( | ||||
|     angle = atan(1.25), | ||||
|     length = 20, | ||||
|   ) | ||||
|   |> yLine(endAbsolute = 0) | ||||
|   |> close() | ||||
|  | ||||
| extrude001 = extrude(sketch001, length = 5) | ||||
| ``` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										48
									
								
								docs/kcl-std/functions/std-math-atan2.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								docs/kcl-std/functions/std-math-atan2.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										42
									
								
								docs/kcl-std/functions/std-math-ceil.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/kcl-std/functions/std-math-ceil.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-cos.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-cos.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										42
									
								
								docs/kcl-std/functions/std-math-floor.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/kcl-std/functions/std-math-floor.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										42
									
								
								docs/kcl-std/functions/std-math-ln.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/kcl-std/functions/std-math-ln.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										48
									
								
								docs/kcl-std/functions/std-math-log.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								docs/kcl-std/functions/std-math-log.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										42
									
								
								docs/kcl-std/functions/std-math-log10.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/kcl-std/functions/std-math-log10.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										42
									
								
								docs/kcl-std/functions/std-math-log2.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/kcl-std/functions/std-math-log2.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-max.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-max.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-min.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-min.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										48
									
								
								docs/kcl-std/functions/std-math-polar.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								docs/kcl-std/functions/std-math-polar.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										48
									
								
								docs/kcl-std/functions/std-math-pow.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								docs/kcl-std/functions/std-math-pow.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										47
									
								
								docs/kcl-std/functions/std-math-rem.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								docs/kcl-std/functions/std-math-rem.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										42
									
								
								docs/kcl-std/functions/std-math-round.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										42
									
								
								docs/kcl-std/functions/std-math-round.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-sin.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-sin.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-sqrt.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-sqrt.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-math-tan.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-math-tan.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										122
									
								
								docs/kcl-std/functions/std-offsetPlane.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										122
									
								
								docs/kcl-std/functions/std-offsetPlane.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										287
									
								
								docs/kcl-std/functions/std-revolve.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										287
									
								
								docs/kcl-std/functions/std-revolve.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										61
									
								
								docs/kcl-std/functions/std-sketch-circle.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										61
									
								
								docs/kcl-std/functions/std-sketch-circle.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										122
									
								
								docs/kcl-std/functions/std-sketch-mirror2d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										122
									
								
								docs/kcl-std/functions/std-sketch-mirror2d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										101
									
								
								docs/kcl-std/functions/std-solid-chamfer.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										101
									
								
								docs/kcl-std/functions/std-solid-chamfer.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										96
									
								
								docs/kcl-std/functions/std-solid-fillet.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										96
									
								
								docs/kcl-std/functions/std-solid-fillet.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										86
									
								
								docs/kcl-std/functions/std-solid-hollow.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										86
									
								
								docs/kcl-std/functions/std-solid-hollow.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										193
									
								
								docs/kcl-std/functions/std-solid-shell.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										193
									
								
								docs/kcl-std/functions/std-solid-shell.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										27
									
								
								docs/kcl-std/functions/std-units-toCentimeters.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/kcl-std/functions/std-units-toCentimeters.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | ||||
| --- | ||||
| title: "std::units::toCentimeters" | ||||
| excerpt: "Convert a number to centimeters from its current units." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Convert a number to centimeters from its current units. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| units::toCentimeters(@num: number(cm)): number(cm) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(cm)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(cm)` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-units-toDegrees.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-units-toDegrees.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										27
									
								
								docs/kcl-std/functions/std-units-toFeet.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/kcl-std/functions/std-units-toFeet.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | ||||
| --- | ||||
| title: "std::units::toFeet" | ||||
| excerpt: "Convert a number to feet from its current units." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Convert a number to feet from its current units. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| units::toFeet(@num: number(ft)): number(ft) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(ft)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(ft)` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										27
									
								
								docs/kcl-std/functions/std-units-toInches.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/kcl-std/functions/std-units-toInches.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | ||||
| --- | ||||
| title: "std::units::toInches" | ||||
| excerpt: "Convert a number to inches from its current units." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Convert a number to inches from its current units. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| units::toInches(@num: number(in)): number(in) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(in)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(in)` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										27
									
								
								docs/kcl-std/functions/std-units-toMeters.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/kcl-std/functions/std-units-toMeters.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | ||||
| --- | ||||
| title: "std::units::toMeters" | ||||
| excerpt: "Convert a number to meters from its current units." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Convert a number to meters from its current units. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| units::toMeters(@num: number(m)): number(m) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(m)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(m)` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										27
									
								
								docs/kcl-std/functions/std-units-toMillimeters.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/kcl-std/functions/std-units-toMillimeters.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | ||||
| --- | ||||
| title: "std::units::toMillimeters" | ||||
| excerpt: "Convert a number to millimeters from its current units." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Convert a number to millimeters from its current units. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| units::toMillimeters(@num: number(mm)): number(mm) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(mm)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(mm)` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										44
									
								
								docs/kcl-std/functions/std-units-toRadians.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl-std/functions/std-units-toRadians.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										27
									
								
								docs/kcl-std/functions/std-units-toYards.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/kcl-std/functions/std-units-toYards.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | ||||
| --- | ||||
| title: "std::units::toYards" | ||||
| excerpt: "Converts a number to yards from its current units." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Converts a number to yards from its current units. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| units::toYards(@num: number(yd)): number(yd) | ||||
| ``` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `num` | `number(yd)` |  | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number(yd)` | ||||
|  | ||||
|  | ||||
|  | ||||
							
								
								
									
										54
									
								
								docs/kcl-std/getCommonEdge.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								docs/kcl-std/getCommonEdge.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										45
									
								
								docs/kcl-std/getNextAdjacentEdge.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								docs/kcl-std/getNextAdjacentEdge.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										45
									
								
								docs/kcl-std/getOppositeEdge.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								docs/kcl-std/getOppositeEdge.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										45
									
								
								docs/kcl-std/getPreviousAdjacentEdge.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										45
									
								
								docs/kcl-std/getPreviousAdjacentEdge.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										160
									
								
								docs/kcl-std/index.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										160
									
								
								docs/kcl-std/index.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,160 @@ | ||||
| --- | ||||
| title: "KCL Standard Library" | ||||
| excerpt: "Documentation for the KCL standard library for the Zoo Design Studio." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| ## Table of Contents | ||||
|  | ||||
| ### Functions | ||||
|  | ||||
| * [**std**](/docs/kcl-std/modules/std) | ||||
|   * [`angledLine`](/docs/kcl-std/angledLine) | ||||
|   * [`angledLineThatIntersects`](/docs/kcl-std/angledLineThatIntersects) | ||||
|   * [`appearance`](/docs/kcl-std/appearance) | ||||
|   * [`arc`](/docs/kcl-std/arc) | ||||
|   * [`assert`](/docs/kcl-std/assert) | ||||
|   * [`assertIs`](/docs/kcl-std/assertIs) | ||||
|   * [`bezierCurve`](/docs/kcl-std/bezierCurve) | ||||
|   * [`circleThreePoint`](/docs/kcl-std/circleThreePoint) | ||||
|   * [`clone`](/docs/kcl-std/clone) | ||||
|   * [`close`](/docs/kcl-std/close) | ||||
|   * [`extrude`](/docs/kcl-std/extrude) | ||||
|   * [`getCommonEdge`](/docs/kcl-std/getCommonEdge) | ||||
|   * [`getNextAdjacentEdge`](/docs/kcl-std/getNextAdjacentEdge) | ||||
|   * [`getOppositeEdge`](/docs/kcl-std/getOppositeEdge) | ||||
|   * [`getPreviousAdjacentEdge`](/docs/kcl-std/getPreviousAdjacentEdge) | ||||
|   * [`helix`](/docs/kcl-std/functions/std-helix) | ||||
|   * [`intersect`](/docs/kcl-std/intersect) | ||||
|   * [`involuteCircular`](/docs/kcl-std/involuteCircular) | ||||
|   * [`lastSegX`](/docs/kcl-std/lastSegX) | ||||
|   * [`lastSegY`](/docs/kcl-std/lastSegY) | ||||
|   * [`legAngX`](/docs/kcl-std/legAngX) | ||||
|   * [`legAngY`](/docs/kcl-std/legAngY) | ||||
|   * [`legLen`](/docs/kcl-std/legLen) | ||||
|   * [`line`](/docs/kcl-std/line) | ||||
|   * [`loft`](/docs/kcl-std/loft) | ||||
|   * [`map`](/docs/kcl-std/map) | ||||
|   * [`offsetPlane`](/docs/kcl-std/functions/std-offsetPlane) | ||||
|   * [`patternCircular2d`](/docs/kcl-std/patternCircular2d) | ||||
|   * [`patternCircular3d`](/docs/kcl-std/patternCircular3d) | ||||
|   * [`patternLinear2d`](/docs/kcl-std/patternLinear2d) | ||||
|   * [`patternLinear3d`](/docs/kcl-std/patternLinear3d) | ||||
|   * [`patternTransform`](/docs/kcl-std/patternTransform) | ||||
|   * [`patternTransform2d`](/docs/kcl-std/patternTransform2d) | ||||
|   * [`polygon`](/docs/kcl-std/polygon) | ||||
|   * [`pop`](/docs/kcl-std/pop) | ||||
|   * [`profileStart`](/docs/kcl-std/profileStart) | ||||
|   * [`profileStartX`](/docs/kcl-std/profileStartX) | ||||
|   * [`profileStartY`](/docs/kcl-std/profileStartY) | ||||
|   * [`push`](/docs/kcl-std/push) | ||||
|   * [`reduce`](/docs/kcl-std/reduce) | ||||
|   * [`revolve`](/docs/kcl-std/functions/std-revolve) | ||||
|   * [`rotate`](/docs/kcl-std/rotate) | ||||
|   * [`scale`](/docs/kcl-std/scale) | ||||
|   * [`segAng`](/docs/kcl-std/segAng) | ||||
|   * [`segEnd`](/docs/kcl-std/segEnd) | ||||
|   * [`segEndX`](/docs/kcl-std/segEndX) | ||||
|   * [`segEndY`](/docs/kcl-std/segEndY) | ||||
|   * [`segLen`](/docs/kcl-std/segLen) | ||||
|   * [`segStart`](/docs/kcl-std/segStart) | ||||
|   * [`segStartX`](/docs/kcl-std/segStartX) | ||||
|   * [`segStartY`](/docs/kcl-std/segStartY) | ||||
|   * [`startProfile`](/docs/kcl-std/startProfile) | ||||
|   * [`startSketchOn`](/docs/kcl-std/startSketchOn) | ||||
|   * [`subtract`](/docs/kcl-std/subtract) | ||||
|   * [`subtract2d`](/docs/kcl-std/subtract2d) | ||||
|   * [`sweep`](/docs/kcl-std/sweep) | ||||
|   * [`tangentToEnd`](/docs/kcl-std/tangentToEnd) | ||||
|   * [`tangentialArc`](/docs/kcl-std/tangentialArc) | ||||
|   * [`translate`](/docs/kcl-std/translate) | ||||
|   * [`union`](/docs/kcl-std/union) | ||||
|   * [`xLine`](/docs/kcl-std/xLine) | ||||
|   * [`yLine`](/docs/kcl-std/yLine) | ||||
| * [**std::math**](/docs/kcl-std/modules/std-math) | ||||
|   * [`abs`](/docs/kcl-std/functions/std-math-abs) | ||||
|   * [`acos`](/docs/kcl-std/functions/std-math-acos) | ||||
|   * [`asin`](/docs/kcl-std/functions/std-math-asin) | ||||
|   * [`atan`](/docs/kcl-std/functions/std-math-atan) | ||||
|   * [`atan2`](/docs/kcl-std/functions/std-math-atan2) | ||||
|   * [`ceil`](/docs/kcl-std/functions/std-math-ceil) | ||||
|   * [`cos`](/docs/kcl-std/functions/std-math-cos) | ||||
|   * [`floor`](/docs/kcl-std/functions/std-math-floor) | ||||
|   * [`ln`](/docs/kcl-std/functions/std-math-ln) | ||||
|   * [`log`](/docs/kcl-std/functions/std-math-log) | ||||
|   * [`log10`](/docs/kcl-std/functions/std-math-log10) | ||||
|   * [`log2`](/docs/kcl-std/functions/std-math-log2) | ||||
|   * [`max`](/docs/kcl-std/functions/std-math-max) | ||||
|   * [`min`](/docs/kcl-std/functions/std-math-min) | ||||
|   * [`polar`](/docs/kcl-std/functions/std-math-polar) | ||||
|   * [`pow`](/docs/kcl-std/functions/std-math-pow) | ||||
|   * [`rem`](/docs/kcl-std/functions/std-math-rem) | ||||
|   * [`round`](/docs/kcl-std/functions/std-math-round) | ||||
|   * [`sin`](/docs/kcl-std/functions/std-math-sin) | ||||
|   * [`sqrt`](/docs/kcl-std/functions/std-math-sqrt) | ||||
|   * [`tan`](/docs/kcl-std/functions/std-math-tan) | ||||
| * [**std::sketch**](/docs/kcl-std/modules/std-sketch) | ||||
|   * [`circle`](/docs/kcl-std/functions/std-sketch-circle) | ||||
|   * [`mirror2d`](/docs/kcl-std/functions/std-sketch-mirror2d) | ||||
| * [**std::solid**](/docs/kcl-std/modules/std-solid) | ||||
|   * [`chamfer`](/docs/kcl-std/functions/std-solid-chamfer) | ||||
|   * [`fillet`](/docs/kcl-std/functions/std-solid-fillet) | ||||
|   * [`hollow`](/docs/kcl-std/functions/std-solid-hollow) | ||||
|   * [`shell`](/docs/kcl-std/functions/std-solid-shell) | ||||
| * [**std::units**](/docs/kcl-std/modules/std-units) | ||||
|   * [`units::toCentimeters`](/docs/kcl-std/functions/std-units-toCentimeters) | ||||
|   * [`units::toDegrees`](/docs/kcl-std/functions/std-units-toDegrees) | ||||
|   * [`units::toFeet`](/docs/kcl-std/functions/std-units-toFeet) | ||||
|   * [`units::toInches`](/docs/kcl-std/functions/std-units-toInches) | ||||
|   * [`units::toMeters`](/docs/kcl-std/functions/std-units-toMeters) | ||||
|   * [`units::toMillimeters`](/docs/kcl-std/functions/std-units-toMillimeters) | ||||
|   * [`units::toRadians`](/docs/kcl-std/functions/std-units-toRadians) | ||||
|   * [`units::toYards`](/docs/kcl-std/functions/std-units-toYards) | ||||
|  | ||||
| ### Constants | ||||
|  | ||||
| * [**std**](/docs/kcl-std/modules/std) | ||||
|   * [`END`](/docs/kcl-std/consts/std-END) | ||||
|   * [`START`](/docs/kcl-std/consts/std-START) | ||||
|   * [`X`](/docs/kcl-std/consts/std-X) | ||||
|   * [`XY`](/docs/kcl-std/consts/std-XY) | ||||
|   * [`XZ`](/docs/kcl-std/consts/std-XZ) | ||||
|   * [`Y`](/docs/kcl-std/consts/std-Y) | ||||
|   * [`YZ`](/docs/kcl-std/consts/std-YZ) | ||||
|   * [`Z`](/docs/kcl-std/consts/std-Z) | ||||
| * [**std::math**](/docs/kcl-std/modules/std-math) | ||||
|   * [`E`](/docs/kcl-std/consts/std-math-E) | ||||
|   * [`PI`](/docs/kcl-std/consts/std-math-PI) | ||||
|   * [`TAU`](/docs/kcl-std/consts/std-math-TAU) | ||||
| * [**std::turns**](/docs/kcl-std/modules/std-turns) | ||||
|   * [`turns::HALF_TURN`](/docs/kcl-std/consts/std-turns-HALF_TURN) | ||||
|   * [`turns::QUARTER_TURN`](/docs/kcl-std/consts/std-turns-QUARTER_TURN) | ||||
|   * [`turns::THREE_QUARTER_TURN`](/docs/kcl-std/consts/std-turns-THREE_QUARTER_TURN) | ||||
|   * [`turns::ZERO`](/docs/kcl-std/consts/std-turns-ZERO) | ||||
|  | ||||
| ### Types | ||||
|  | ||||
| See also the [types overview](/docs/kcl-lang/types) | ||||
|  | ||||
| * [**Primitive types**](/docs/kcl-std/modules/Primitive types) | ||||
|   * [`End`](/docs/kcl-std/types#End) | ||||
|   * [`ImportedGeometry`](/docs/kcl-std/types#ImportedGeometry) | ||||
|   * [`Start`](/docs/kcl-std/types#Start) | ||||
|   * [`TagDeclarator`](/docs/kcl-std/types#TagDeclarator) | ||||
|   * [`TagIdentifier`](/docs/kcl-std/types#TagIdentifier) | ||||
|   * [`any`](/docs/kcl-std/types/std-types-any) | ||||
|   * [`bool`](/docs/kcl-std/types/std-types-bool) | ||||
|   * [`number`](/docs/kcl-std/types/std-types-number) | ||||
|   * [`string`](/docs/kcl-std/types/std-types-string) | ||||
|   * [`tag`](/docs/kcl-std/types/std-types-tag) | ||||
| * [**std::types**](/docs/kcl-std/modules/std-types) | ||||
|   * [`Axis2d`](/docs/kcl-std/types/std-types-Axis2d) | ||||
|   * [`Axis3d`](/docs/kcl-std/types/std-types-Axis3d) | ||||
|   * [`Edge`](/docs/kcl-std/types/std-types-Edge) | ||||
|   * [`Face`](/docs/kcl-std/types/std-types-Face) | ||||
|   * [`Helix`](/docs/kcl-std/types/std-types-Helix) | ||||
|   * [`Plane`](/docs/kcl-std/types/std-types-Plane) | ||||
|   * [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | ||||
|   * [`Point3d`](/docs/kcl-std/types/std-types-Point3d) | ||||
|   * [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | ||||
|   * [`Solid`](/docs/kcl-std/types/std-types-Solid) | ||||
							
								
								
									
										82
									
								
								docs/kcl-std/intersect.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										82
									
								
								docs/kcl-std/intersect.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										57
									
								
								docs/kcl-std/involuteCircular.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								docs/kcl-std/involuteCircular.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										43
									
								
								docs/kcl-std/lastSegX.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								docs/kcl-std/lastSegX.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										43
									
								
								docs/kcl-std/lastSegY.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								docs/kcl-std/lastSegY.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										41
									
								
								docs/kcl-std/legAngX.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								docs/kcl-std/legAngX.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,41 @@ | ||||
| --- | ||||
| title: "legAngX" | ||||
| excerpt: "Compute the angle of the given leg for x." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Compute the angle of the given leg for x. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| legAngX( | ||||
|   hypotenuse: number, | ||||
|   leg: number, | ||||
| ): number | ||||
| ``` | ||||
|  | ||||
| ### Tags | ||||
|  | ||||
| * `utilities` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `hypotenuse` | [`number`](/docs/kcl-std/types/std-types-number) | The length of the triangle's hypotenuse | Yes | | ||||
| | `leg` | [`number`](/docs/kcl-std/types/std-types-number) | The length of one of the triangle's legs (i.e. non-hypotenuse side) | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`number`](/docs/kcl-std/types/std-types-number) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| ```kcl | ||||
| legAngX(hypotenuse = 5, leg = 3) | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										41
									
								
								docs/kcl-std/legAngY.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								docs/kcl-std/legAngY.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,41 @@ | ||||
| --- | ||||
| title: "legAngY" | ||||
| excerpt: "Compute the angle of the given leg for y." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Compute the angle of the given leg for y. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| legAngY( | ||||
|   hypotenuse: number, | ||||
|   leg: number, | ||||
| ): number | ||||
| ``` | ||||
|  | ||||
| ### Tags | ||||
|  | ||||
| * `utilities` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `hypotenuse` | [`number`](/docs/kcl-std/types/std-types-number) | The length of the triangle's hypotenuse | Yes | | ||||
| | `leg` | [`number`](/docs/kcl-std/types/std-types-number) | The length of one of the triangle's legs (i.e. non-hypotenuse side) | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`number`](/docs/kcl-std/types/std-types-number) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| ```kcl | ||||
| legAngY(hypotenuse = 5, leg = 3) | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										41
									
								
								docs/kcl-std/legLen.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								docs/kcl-std/legLen.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,41 @@ | ||||
| --- | ||||
| title: "legLen" | ||||
| excerpt: "Compute the length of the given leg." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Compute the length of the given leg. | ||||
|  | ||||
|  | ||||
|  | ||||
| ```kcl | ||||
| legLen( | ||||
|   hypotenuse: number, | ||||
|   leg: number, | ||||
| ): number | ||||
| ``` | ||||
|  | ||||
| ### Tags | ||||
|  | ||||
| * `utilities` | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `hypotenuse` | [`number`](/docs/kcl-std/types/std-types-number) | The length of the triangle's hypotenuse | Yes | | ||||
| | `leg` | [`number`](/docs/kcl-std/types/std-types-number) | The length of one of the triangle's legs (i.e. non-hypotenuse side) | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`number`](/docs/kcl-std/types/std-types-number) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| ```kcl | ||||
| legLen(hypotenuse = 5, leg = 3) | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										62
									
								
								docs/kcl-std/line.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								docs/kcl-std/line.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										121
									
								
								docs/kcl-std/loft.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										121
									
								
								docs/kcl-std/loft.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										62
									
								
								docs/kcl-std/map.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								docs/kcl-std/map.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										38
									
								
								docs/kcl-std/modules/std-math.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								docs/kcl-std/modules/std-math.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,38 @@ | ||||
| --- | ||||
| title: "std::math" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`E`](/docs/kcl-std/consts/std-math-E) | ||||
| * [`PI`](/docs/kcl-std/consts/std-math-PI) | ||||
| * [`TAU`](/docs/kcl-std/consts/std-math-TAU) | ||||
| * [`abs`](/docs/kcl-std/functions/std-math-abs) | ||||
| * [`acos`](/docs/kcl-std/functions/std-math-acos) | ||||
| * [`asin`](/docs/kcl-std/functions/std-math-asin) | ||||
| * [`atan`](/docs/kcl-std/functions/std-math-atan) | ||||
| * [`atan2`](/docs/kcl-std/functions/std-math-atan2) | ||||
| * [`ceil`](/docs/kcl-std/functions/std-math-ceil) | ||||
| * [`cos`](/docs/kcl-std/functions/std-math-cos) | ||||
| * [`floor`](/docs/kcl-std/functions/std-math-floor) | ||||
| * [`ln`](/docs/kcl-std/functions/std-math-ln) | ||||
| * [`log`](/docs/kcl-std/functions/std-math-log) | ||||
| * [`log10`](/docs/kcl-std/functions/std-math-log10) | ||||
| * [`log2`](/docs/kcl-std/functions/std-math-log2) | ||||
| * [`max`](/docs/kcl-std/functions/std-math-max) | ||||
| * [`min`](/docs/kcl-std/functions/std-math-min) | ||||
| * [`polar`](/docs/kcl-std/functions/std-math-polar) | ||||
| * [`pow`](/docs/kcl-std/functions/std-math-pow) | ||||
| * [`rem`](/docs/kcl-std/functions/std-math-rem) | ||||
| * [`round`](/docs/kcl-std/functions/std-math-round) | ||||
| * [`sin`](/docs/kcl-std/functions/std-math-sin) | ||||
| * [`sqrt`](/docs/kcl-std/functions/std-math-sqrt) | ||||
| * [`tan`](/docs/kcl-std/functions/std-math-tan) | ||||
|  | ||||
							
								
								
									
										16
									
								
								docs/kcl-std/modules/std-sketch.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								docs/kcl-std/modules/std-sketch.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,16 @@ | ||||
| --- | ||||
| title: "std::sketch" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`circle`](/docs/kcl-std/functions/std-sketch-circle) | ||||
| * [`mirror2d`](/docs/kcl-std/functions/std-sketch-mirror2d) | ||||
|  | ||||
							
								
								
									
										18
									
								
								docs/kcl-std/modules/std-solid.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/kcl-std/modules/std-solid.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,18 @@ | ||||
| --- | ||||
| title: "std::solid" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`chamfer`](/docs/kcl-std/functions/std-solid-chamfer) | ||||
| * [`fillet`](/docs/kcl-std/functions/std-solid-fillet) | ||||
| * [`hollow`](/docs/kcl-std/functions/std-solid-hollow) | ||||
| * [`shell`](/docs/kcl-std/functions/std-solid-shell) | ||||
|  | ||||
							
								
								
									
										18
									
								
								docs/kcl-std/modules/std-turns.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/kcl-std/modules/std-turns.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,18 @@ | ||||
| --- | ||||
| title: "std::turns" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`turns::HALF_TURN`](/docs/kcl-std/consts/std-turns-HALF_TURN) | ||||
| * [`turns::QUARTER_TURN`](/docs/kcl-std/consts/std-turns-QUARTER_TURN) | ||||
| * [`turns::THREE_QUARTER_TURN`](/docs/kcl-std/consts/std-turns-THREE_QUARTER_TURN) | ||||
| * [`turns::ZERO`](/docs/kcl-std/consts/std-turns-ZERO) | ||||
|  | ||||
							
								
								
									
										29
									
								
								docs/kcl-std/modules/std-types.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								docs/kcl-std/modules/std-types.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,29 @@ | ||||
| --- | ||||
| title: "std::types" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ## Types | ||||
|  | ||||
| * [`Axis2d`](/docs/kcl-std/types/std-types-Axis2d) | ||||
| * [`Axis3d`](/docs/kcl-std/types/std-types-Axis3d) | ||||
| * [`Edge`](/docs/kcl-std/types/std-types-Edge) | ||||
| * [`Face`](/docs/kcl-std/types/std-types-Face) | ||||
| * [`Helix`](/docs/kcl-std/types/std-types-Helix) | ||||
| * [`Plane`](/docs/kcl-std/types/std-types-Plane) | ||||
| * [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | ||||
| * [`Point3d`](/docs/kcl-std/types/std-types-Point3d) | ||||
| * [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | ||||
| * [`Solid`](/docs/kcl-std/types/std-types-Solid) | ||||
| * [`any`](/docs/kcl-std/types/std-types-any) | ||||
| * [`bool`](/docs/kcl-std/types/std-types-bool) | ||||
| * [`number`](/docs/kcl-std/types/std-types-number) | ||||
| * [`string`](/docs/kcl-std/types/std-types-string) | ||||
| * [`tag`](/docs/kcl-std/types/std-types-tag) | ||||
							
								
								
									
										22
									
								
								docs/kcl-std/modules/std-units.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								docs/kcl-std/modules/std-units.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,22 @@ | ||||
| --- | ||||
| title: "std::units" | ||||
| excerpt: "Functions for converting numbers to different units. " | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| Functions for converting numbers to different units.  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`units::toCentimeters`](/docs/kcl-std/functions/std-units-toCentimeters) | ||||
| * [`units::toDegrees`](/docs/kcl-std/functions/std-units-toDegrees) | ||||
| * [`units::toFeet`](/docs/kcl-std/functions/std-units-toFeet) | ||||
| * [`units::toInches`](/docs/kcl-std/functions/std-units-toInches) | ||||
| * [`units::toMeters`](/docs/kcl-std/functions/std-units-toMeters) | ||||
| * [`units::toMillimeters`](/docs/kcl-std/functions/std-units-toMillimeters) | ||||
| * [`units::toRadians`](/docs/kcl-std/functions/std-units-toRadians) | ||||
| * [`units::toYards`](/docs/kcl-std/functions/std-units-toYards) | ||||
|  | ||||
							
								
								
									
										33
									
								
								docs/kcl-std/modules/std.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								docs/kcl-std/modules/std.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,33 @@ | ||||
| --- | ||||
| title: "std" | ||||
| excerpt: "The KCL standard library " | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| The KCL standard library  | ||||
|  | ||||
| Contains frequently used constants, functions for interacting with the KittyCAD servers to create sketches and geometry, and utility functions.  | ||||
|  | ||||
| ## Modules | ||||
|  | ||||
| * [`math`](/docs/kcl-std/modules/std-math) | ||||
| * [`sketch`](/docs/kcl-std/modules/std-sketch) | ||||
| * [`solid`](/docs/kcl-std/modules/std-solid) | ||||
| * [`turns::turns`](/docs/kcl-std/modules/std-turns) | ||||
| * [`types`](/docs/kcl-std/modules/std-types) | ||||
| * [`units::units`](/docs/kcl-std/modules/std-units) | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`END`](/docs/kcl-std/consts/std-END) | ||||
| * [`START`](/docs/kcl-std/consts/std-START) | ||||
| * [`X`](/docs/kcl-std/consts/std-X) | ||||
| * [`XY`](/docs/kcl-std/consts/std-XY) | ||||
| * [`XZ`](/docs/kcl-std/consts/std-XZ) | ||||
| * [`Y`](/docs/kcl-std/consts/std-Y) | ||||
| * [`YZ`](/docs/kcl-std/consts/std-YZ) | ||||
| * [`Z`](/docs/kcl-std/consts/std-Z) | ||||
| * [`helix`](/docs/kcl-std/functions/std-helix) | ||||
| * [`offsetPlane`](/docs/kcl-std/functions/std-offsetPlane) | ||||
| * [`revolve`](/docs/kcl-std/functions/std-revolve) | ||||
|  | ||||
							
								
								
									
										60
									
								
								docs/kcl-std/patternCircular2d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										60
									
								
								docs/kcl-std/patternCircular2d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										59
									
								
								docs/kcl-std/patternCircular3d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										59
									
								
								docs/kcl-std/patternCircular3d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										49
									
								
								docs/kcl-std/patternLinear2d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										49
									
								
								docs/kcl-std/patternLinear2d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										111
									
								
								docs/kcl-std/patternLinear3d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										111
									
								
								docs/kcl-std/patternLinear3d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										224
									
								
								docs/kcl-std/patternTransform.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										224
									
								
								docs/kcl-std/patternTransform.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										51
									
								
								docs/kcl-std/patternTransform2d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								docs/kcl-std/patternTransform2d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										68
									
								
								docs/kcl-std/polygon.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										68
									
								
								docs/kcl-std/polygon.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										54
									
								
								docs/kcl-std/pop.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								docs/kcl-std/pop.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										41
									
								
								docs/kcl-std/profileStart.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								docs/kcl-std/profileStart.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										39
									
								
								docs/kcl-std/profileStartX.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										39
									
								
								docs/kcl-std/profileStartX.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										38
									
								
								docs/kcl-std/profileStartY.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								docs/kcl-std/profileStartY.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										46
									
								
								docs/kcl-std/push.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										46
									
								
								docs/kcl-std/push.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user