Compare commits
	
		
			24 Commits
		
	
	
		
			franknoiro
			...
			maxammann/
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 8b20f898fe | |||
| d7c5c3cf9d | |||
| 270781d5cd | |||
| 96b93f8d51 | |||
| 59b1c414f0 | |||
| fd07b8cff5 | |||
| 21efb2c0bd | |||
| 30029a63a1 | |||
| 9f5003cafc | |||
| 5232e1d40a | |||
| 23c25c2b50 | |||
| 50273c0edc | |||
| 8a03bf50e3 | |||
| 7500ef0065 | |||
| 099c48cd63 | |||
| f35cd3ef26 | |||
| 695c432d1e | |||
| 2835665a6a | |||
| 45707d2974 | |||
| b2e1d21d45 | |||
| b98f5605b6 | |||
| c050e03df1 | |||
| b6fa4325f0 | |||
| 0804aecc63 | 
							
								
								
									
										13
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,13 @@ | ||||
| # Set default behavior to automatically normalize line endings. | ||||
| * text=auto | ||||
|  | ||||
| # Force batch scripts to always use CRLF line endings so that if a repo is accessed | ||||
| # in Windows via a file share from Linux, the scripts will work. | ||||
| *.{cmd,[cC][mM][dD]} text working-tree-encoding=UTF-16LE eol=CRLF | ||||
| *.{bat,[bB][aA][tT]} text working-tree-encoding=UTF-16LE eol=CRLF | ||||
| *.{ics,[iI][cC][sS]} text working-tree-encoding=UTF-16LE eol=CRLF | ||||
| *.{ps1,[iP][sS][1]} text working-tree-encoding=UTF-16LE eol=CRLF | ||||
|  | ||||
| # Force bash scripts to always use LF line endings so that if a repo is accessed | ||||
| # in Unix via a file share from Windows, the scripts will work. | ||||
| *.sh text eol=lfol=lf | ||||
							
								
								
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @ -41,9 +41,12 @@ e2e/playwright/playwright-secrets.env | ||||
| e2e/playwright/temp1.png | ||||
| e2e/playwright/temp2.png | ||||
| e2e/playwright/temp3.png | ||||
| # this will be overridden for specific directories | ||||
| e2e/playwright/**/*.png | ||||
| # exports from snapshot-tests.spec.ts "exports of each format should work" | ||||
| e2e/playwright/export-snapshots/* | ||||
| !e2e/playwright/export-snapshots/*.png | ||||
| !e2e/playwright/snapshot-tests.spec.ts-snapshots/*.png | ||||
|  | ||||
| /kcl-samples | ||||
| /test-results/ | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "HALF_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| HALF_TURN: number(deg) = 180deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| QUARTER_TURN: number(deg) = 90deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "THREE_QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| THREE_QUARTER_TURN: number(deg) = 270deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/ZERO.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/ZERO.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "ZERO" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| ZERO: number = 0 | ||||
| ``` | ||||
|  | ||||
|  | ||||
| @ -25,7 +25,7 @@ abs(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ acos(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -23,7 +23,7 @@ angleToMatchLengthX(tag: TagIdentifier, to: number, sketch: Sketch) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -23,7 +23,7 @@ angleToMatchLengthY(tag: TagIdentifier, to: number, sketch: Sketch) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ asin(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -22,7 +22,7 @@ assert(data: bool, message: string) -> () | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `()`  | ||||
| `()` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -24,7 +24,7 @@ assertEqual(left: number, right: number, epsilon: number, message: string) -> () | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `()`  | ||||
| `()` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -23,7 +23,7 @@ assertGreaterThan(left: number, right: number, message: string) -> () | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `()`  | ||||
| `()` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -23,7 +23,7 @@ assertGreaterThanOrEq(left: number, right: number, message: string) -> () | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `()`  | ||||
| `()` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -23,7 +23,7 @@ assertLessThan(left: number, right: number, message: string) -> () | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `()`  | ||||
| `()` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -23,7 +23,7 @@ assertLessThanOrEq(left: number, right: number, message: string) -> () | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `()`  | ||||
| `()` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ atan(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ atan2(y: number, x: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ ceil(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -18,12 +18,12 @@ chamfer(data: ChamferData, solid: Solid, tag?: TagDeclarator) -> Solid | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `data` | [`ChamferData`](/docs/kcl/types/ChamferData) | Data for chamfers. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | An solid is a collection of extrude surfaces. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | A solid is a collection of extrude surfaces. | Yes | | ||||
| | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ cm() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
							
								
								
									
										32
									
								
								docs/kcl/const_E.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								docs/kcl/const_E.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										15
									
								
								docs/kcl/const_HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "HALF_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| HALF_TURN: number(deg) = 180deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										28
									
								
								docs/kcl/const_PI.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								docs/kcl/const_PI.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										15
									
								
								docs/kcl/const_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| QUARTER_TURN: number(deg) = 90deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										32
									
								
								docs/kcl/const_TAU.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								docs/kcl/const_TAU.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										15
									
								
								docs/kcl/const_THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "THREE_QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| THREE_QUARTER_TURN: number(deg) = 270deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/const_ZERO.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_ZERO.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "ZERO" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| ZERO: number = 0 | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										32
									
								
								docs/kcl/const_const_std-math-E.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								docs/kcl/const_const_std-math-E.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										28
									
								
								docs/kcl/const_const_std-math-PI.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								docs/kcl/const_const_std-math-PI.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										32
									
								
								docs/kcl/const_const_std-math-TAU.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								docs/kcl/const_const_std-math-TAU.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										15
									
								
								docs/kcl/const_const_std-prelude-HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_const_std-prelude-HALF_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::prelude::HALF_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| std::prelude::HALF_TURN: number(deg) = 180deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/const_const_std-prelude-QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_const_std-prelude-QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::prelude::QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| std::prelude::QUARTER_TURN: number(deg) = 90deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/const_const_std-prelude-THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_const_std-prelude-THREE_QUARTER_TURN.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::prelude::THREE_QUARTER_TURN" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| std::prelude::THREE_QUARTER_TURN: number(deg) = 270deg | ||||
| ``` | ||||
|  | ||||
|  | ||||
							
								
								
									
										15
									
								
								docs/kcl/const_const_std-prelude-ZERO.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								docs/kcl/const_const_std-prelude-ZERO.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| --- | ||||
| title: "std::prelude::ZERO" | ||||
| excerpt: "" | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
|  | ||||
| ```js | ||||
| std::prelude::ZERO: number = 0 | ||||
| ``` | ||||
|  | ||||
|  | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -4,9 +4,11 @@ excerpt: "Return the value of Euler’s number `e`." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| **WARNING:** This function is deprecated. | ||||
|  | ||||
| Return the value of Euler’s number `e`. | ||||
|  | ||||
|  | ||||
| **DEPRECATED** use the constant E | ||||
|  | ||||
| ```js | ||||
| e() -> number | ||||
| @ -20,7 +22,7 @@ e() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -18,12 +18,12 @@ fillet(data: FilletData, solid: Solid, tag?: TagDeclarator) -> Solid | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `data` | [`FilletData`](/docs/kcl/types/FilletData) | Data for fillets. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | An solid is a collection of extrude surfaces. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | A solid is a collection of extrude surfaces. | Yes | | ||||
| | `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) |  | No | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ floor(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ ft() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `Uuid`  | ||||
| `Uuid` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ getOppositeEdge(tag: TagIdentifier) -> Uuid | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `Uuid`  | ||||
| `Uuid` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `Uuid`  | ||||
| `Uuid` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -18,11 +18,11 @@ helixRevolutions(data: HelixRevolutionsData, solid: Solid) -> Solid | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `data` | [`HelixRevolutionsData`](/docs/kcl/types/HelixRevolutionsData) | Data for helix revolutions. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | An solid is a collection of extrude surfaces. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | A solid is a collection of extrude surfaces. | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -18,11 +18,11 @@ hollow(thickness: number, solid: Solid) -> Solid | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `thickness` | `number` |  | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | An solid is a collection of extrude surfaces. | Yes | | ||||
| | `solid` | [`Solid`](/docs/kcl/types/Solid) | A solid is a collection of extrude surfaces. | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ inch() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -9,110 +9,117 @@ layout: manual | ||||
| * [Types](kcl/types) | ||||
| * [Modules](kcl/modules) | ||||
| * [Known Issues](kcl/KNOWN-ISSUES) | ||||
| * [`abs`](kcl/abs) | ||||
| * [`acos`](kcl/acos) | ||||
| * [`angleToMatchLengthX`](kcl/angleToMatchLengthX) | ||||
| * [`angleToMatchLengthY`](kcl/angleToMatchLengthY) | ||||
| * [`angledLine`](kcl/angledLine) | ||||
| * [`angledLineOfXLength`](kcl/angledLineOfXLength) | ||||
| * [`angledLineOfYLength`](kcl/angledLineOfYLength) | ||||
| * [`angledLineThatIntersects`](kcl/angledLineThatIntersects) | ||||
| * [`angledLineToX`](kcl/angledLineToX) | ||||
| * [`angledLineToY`](kcl/angledLineToY) | ||||
| * [`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) | ||||
| * [`circle`](kcl/circle) | ||||
| * [`circleThreePoint`](kcl/circleThreePoint) | ||||
| * [`close`](kcl/close) | ||||
| * [`cm`](kcl/cm) | ||||
| * [`cos`](kcl/cos) | ||||
| * [`e`](kcl/e) | ||||
| * [`extrude`](kcl/extrude) | ||||
| * [`fillet`](kcl/fillet) | ||||
| * [`floor`](kcl/floor) | ||||
| * [`ft`](kcl/ft) | ||||
| * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge) | ||||
| * [`getOppositeEdge`](kcl/getOppositeEdge) | ||||
| * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge) | ||||
| * [`helix`](kcl/helix) | ||||
| * [`helixRevolutions`](kcl/helixRevolutions) | ||||
| * [`hole`](kcl/hole) | ||||
| * [`hollow`](kcl/hollow) | ||||
| * [`inch`](kcl/inch) | ||||
| * [`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) | ||||
| * [`m`](kcl/m) | ||||
| * [`map`](kcl/map) | ||||
| * [`max`](kcl/max) | ||||
| * [`min`](kcl/min) | ||||
| * [`mirror2d`](kcl/mirror2d) | ||||
| * [`mm`](kcl/mm) | ||||
| * [`offsetPlane`](kcl/offsetPlane) | ||||
| * [`patternCircular2d`](kcl/patternCircular2d) | ||||
| * [`patternCircular3d`](kcl/patternCircular3d) | ||||
| * [`patternLinear2d`](kcl/patternLinear2d) | ||||
| * [`patternLinear3d`](kcl/patternLinear3d) | ||||
| * [`patternTransform`](kcl/patternTransform) | ||||
| * [`patternTransform2d`](kcl/patternTransform2d) | ||||
| * [`pi`](kcl/pi) | ||||
| * [`polar`](kcl/polar) | ||||
| * [`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/revolve) | ||||
| * [`round`](kcl/round) | ||||
| * [`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) | ||||
| * [`sin`](kcl/sin) | ||||
| * [`sqrt`](kcl/sqrt) | ||||
| * [`startProfileAt`](kcl/startProfileAt) | ||||
| * [`startSketchOn`](kcl/startSketchOn) | ||||
| * [`sweep`](kcl/sweep) | ||||
| * [`tan`](kcl/tan) | ||||
| * [`tangentToEnd`](kcl/tangentToEnd) | ||||
| * [`tangentialArc`](kcl/tangentialArc) | ||||
| * [`tangentialArcTo`](kcl/tangentialArcTo) | ||||
| * [`tangentialArcToRelative`](kcl/tangentialArcToRelative) | ||||
| * [`tau`](kcl/tau) | ||||
| * [`toDegrees`](kcl/toDegrees) | ||||
| * [`toRadians`](kcl/toRadians) | ||||
| * [`xLine`](kcl/xLine) | ||||
| * [`xLineTo`](kcl/xLineTo) | ||||
| * [`yLine`](kcl/yLine) | ||||
| * [`yLineTo`](kcl/yLineTo) | ||||
| * [`yd`](kcl/yd) | ||||
| * **`std`** | ||||
|   * [`abs`](kcl/abs) | ||||
|   * [`acos`](kcl/acos) | ||||
|   * [`angleToMatchLengthX`](kcl/angleToMatchLengthX) | ||||
|   * [`angleToMatchLengthY`](kcl/angleToMatchLengthY) | ||||
|   * [`angledLine`](kcl/angledLine) | ||||
|   * [`angledLineOfXLength`](kcl/angledLineOfXLength) | ||||
|   * [`angledLineOfYLength`](kcl/angledLineOfYLength) | ||||
|   * [`angledLineThatIntersects`](kcl/angledLineThatIntersects) | ||||
|   * [`angledLineToX`](kcl/angledLineToX) | ||||
|   * [`angledLineToY`](kcl/angledLineToY) | ||||
|   * [`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) | ||||
|   * [`circle`](kcl/circle) | ||||
|   * [`circleThreePoint`](kcl/circleThreePoint) | ||||
|   * [`close`](kcl/close) | ||||
|   * [`cm`](kcl/cm) | ||||
|   * [`extrude`](kcl/extrude) | ||||
|   * [`fillet`](kcl/fillet) | ||||
|   * [`floor`](kcl/floor) | ||||
|   * [`ft`](kcl/ft) | ||||
|   * [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge) | ||||
|   * [`getOppositeEdge`](kcl/getOppositeEdge) | ||||
|   * [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge) | ||||
|   * [`helix`](kcl/helix) | ||||
|   * [`helixRevolutions`](kcl/helixRevolutions) | ||||
|   * [`hole`](kcl/hole) | ||||
|   * [`hollow`](kcl/hollow) | ||||
|   * [`inch`](kcl/inch) | ||||
|   * [`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) | ||||
|   * [`m`](kcl/m) | ||||
|   * [`map`](kcl/map) | ||||
|   * [`max`](kcl/max) | ||||
|   * [`min`](kcl/min) | ||||
|   * [`mirror2d`](kcl/mirror2d) | ||||
|   * [`mm`](kcl/mm) | ||||
|   * [`offsetPlane`](kcl/offsetPlane) | ||||
|   * [`patternCircular2d`](kcl/patternCircular2d) | ||||
|   * [`patternCircular3d`](kcl/patternCircular3d) | ||||
|   * [`patternLinear2d`](kcl/patternLinear2d) | ||||
|   * [`patternLinear3d`](kcl/patternLinear3d) | ||||
|   * [`patternTransform`](kcl/patternTransform) | ||||
|   * [`patternTransform2d`](kcl/patternTransform2d) | ||||
|   * [`polar`](kcl/polar) | ||||
|   * [`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/revolve) | ||||
|   * [`round`](kcl/round) | ||||
|   * [`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) | ||||
|   * [`sweep`](kcl/sweep) | ||||
|   * [`tangentToEnd`](kcl/tangentToEnd) | ||||
|   * [`tangentialArc`](kcl/tangentialArc) | ||||
|   * [`tangentialArcTo`](kcl/tangentialArcTo) | ||||
|   * [`tangentialArcToRelative`](kcl/tangentialArcToRelative) | ||||
|   * [`toDegrees`](kcl/toDegrees) | ||||
|   * [`toRadians`](kcl/toRadians) | ||||
|   * [`xLine`](kcl/xLine) | ||||
|   * [`xLineTo`](kcl/xLineTo) | ||||
|   * [`yLine`](kcl/yLine) | ||||
|   * [`yLineTo`](kcl/yLineTo) | ||||
|   * [`yd`](kcl/yd) | ||||
| * **`std::math`** | ||||
|   * [`E`](kcl/const_std-math-E) | ||||
|   * [`PI`](kcl/const_std-math-PI) | ||||
|   * [`TAU`](kcl/const_std-math-TAU) | ||||
|   * [`cos`](kcl/std-math-cos) | ||||
|   * [`sin`](kcl/std-math-sin) | ||||
|   * [`tan`](kcl/std-math-tan) | ||||
| * **`std::prelude`** | ||||
|   * [`HALF_TURN`](kcl/const_std-prelude-HALF_TURN) | ||||
|   * [`QUARTER_TURN`](kcl/const_std-prelude-QUARTER_TURN) | ||||
|   * [`THREE_QUARTER_TURN`](kcl/const_std-prelude-THREE_QUARTER_TURN) | ||||
|   * [`ZERO`](kcl/const_std-prelude-ZERO) | ||||
|  | ||||
| @ -27,7 +27,7 @@ int(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ lastSegX(sketch: Sketch) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ lastSegY(sketch: Sketch) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ legAngX(hypotenuse: number, leg: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ legAngY(hypotenuse: number, leg: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ legLen(hypotenuse: number, leg: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ ln(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ loft(sketches: [Sketch], v_degree: NonZeroU32, bez_approximate_rational: bool, b | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ log(num: number, base: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ log10(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ log2(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ m() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -22,7 +22,7 @@ map(array: [KclValue], map_fn: FunctionParam) -> [KclValue] | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[KclValue]`](/docs/kcl/types/KclValue)  | ||||
| [`[KclValue]`](/docs/kcl/types/KclValue) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ max(args: [number]) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ min(args: [number]) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -24,7 +24,7 @@ mirror2d(data: Mirror2dData, sketch_set: SketchSet) -> [Sketch] | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch)  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ mm() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -9,7 +9,7 @@ Offset a plane by a distance along its normal. | ||||
| For example, if you offset the 'XZ' plane by 10, the new plane will be parallel to the 'XZ' plane and 10 units away from it. | ||||
|  | ||||
| ```js | ||||
| offsetPlane(std_plane: StandardPlane, offset: number) -> Plane | ||||
| offsetPlane(plane: PlaneData, offset: number) -> Plane | ||||
| ``` | ||||
|  | ||||
|  | ||||
| @ -17,7 +17,7 @@ offsetPlane(std_plane: StandardPlane, offset: number) -> Plane | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `std_plane` | [`StandardPlane`](/docs/kcl/types/StandardPlane) | Which standard plane (e.g. XY) should this new plane be created from? | Yes | | ||||
| | `plane` | [`PlaneData`](/docs/kcl/types/PlaneData) | The plane (e.g. 'XY') which this new plane is created from. | Yes | | ||||
| | `offset` | `number` | Distance from the standard plane this new plane will be created at. | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| @ -26,7 +26,7 @@ patternCircular2d(sketch_set: SketchSet, instances: integer, center: [number], a | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch)  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -27,7 +27,7 @@ patternCircular3d(solid_set: SolidSet, instances: integer, axis: [number], cente | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Solid]`](/docs/kcl/types/Solid)  | ||||
| [`[Solid]`](/docs/kcl/types/Solid) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ patternLinear2d(sketch_set: SketchSet, instances: integer, distance: number, axi | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch)  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ patternLinear3d(solid_set: SolidSet, instances: integer, distance: number, axis: | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Solid]`](/docs/kcl/types/Solid)  | ||||
| [`[Solid]`](/docs/kcl/types/Solid) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -50,7 +50,7 @@ patternTransform(solid_set: SolidSet, instances: integer, transform: FunctionPar | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Solid]`](/docs/kcl/types/Solid)  | ||||
| [`[Solid]`](/docs/kcl/types/Solid) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -24,7 +24,7 @@ patternTransform2d(sketch_set: SketchSet, instances: integer, transform: Functio | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch)  | ||||
| [`[Sketch]`](/docs/kcl/types/Sketch) | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -4,9 +4,11 @@ excerpt: "Return the value of `pi`. Archimedes’ constant (π)." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| **WARNING:** This function is deprecated. | ||||
|  | ||||
| Return the value of `pi`. Archimedes’ constant (π). | ||||
|  | ||||
|  | ||||
| **DEPRECATED** use the constant PI | ||||
|  | ||||
| ```js | ||||
| pi() -> number | ||||
| @ -20,7 +22,7 @@ pi() -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ polar(data: PolarCoordsData) -> [number] | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `[number]`  | ||||
| `[number]` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -26,7 +26,7 @@ pow(num: number, pow: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ profileStart(sketch: Sketch) -> [number] | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `[number]`  | ||||
| `[number]` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ profileStartX(sketch: Sketch) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ profileStartY(sketch: Sketch) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -76,7 +76,7 @@ assertEqual(sum, 6, 0.00001, "1 + 2 + 3 summed is 6") | ||||
| // Declare a function that sketches a decagon. | ||||
| fn decagon(radius) { | ||||
|   // Each side of the decagon is turned this many degrees from the previous angle. | ||||
|   stepAngle = 1 / 10 * tau() | ||||
|   stepAngle = 1 / 10 * TAU | ||||
|  | ||||
|   // Start the decagon sketch at this point. | ||||
|   startOfDecagonSketch = startSketchOn('XY') | ||||
| @ -97,7 +97,7 @@ fn decagon(radius) { | ||||
|  | ||||
| /* The `decagon` above is basically like this pseudo-code: | ||||
| fn decagon(radius): | ||||
|     stepAngle = (1/10) * tau() | ||||
|     stepAngle = (1/10) * TAU | ||||
|     plane = startSketchOn('XY') | ||||
|     startOfDecagonSketch = startProfileAt([(cos(0)*radius), (sin(0) * radius)], plane) | ||||
|  | ||||
|  | ||||
| @ -26,7 +26,7 @@ rem(num: number, divisor: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -24,7 +24,7 @@ revolve(data: RevolveData, sketch: Sketch) -> Solid | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
| 
 | ||||
| 
 | ||||
| ### Examples | ||||
|  | ||||
| @ -25,7 +25,7 @@ round(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segAng(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segEnd(tag: TagIdentifier) -> [number] | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `[number]`  | ||||
| `[number]` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segEndX(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segEndY(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segLen(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segStart(tag: TagIdentifier) -> [number] | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `[number]`  | ||||
| `[number]` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segStartX(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -21,7 +21,7 @@ segStartY(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -25,7 +25,7 @@ sqrt(num: number) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -6,7 +6,15 @@ layout: manual | ||||
|  | ||||
| Start a new 2-dimensional sketch on a specific plane or face. | ||||
|  | ||||
| ### Sketch on Face Behavior | ||||
|  | ||||
| There are some important behaviors to understand when sketching on a face: | ||||
|  | ||||
| The resulting sketch will _include_ the face and thus Solid that was sketched on. So say you were to export the resulting Sketch / Solid from a sketch on a face, you would get both the artifact of the sketch on the face and the parent face / Solid itself. | ||||
|  | ||||
| This is important to understand because if you were to then sketch on the resulting Solid, it would again include the face and parent Solid that was sketched on. This could go on indefinitely. | ||||
|  | ||||
| The point is if you want to export the result of a sketch on a face, you only need to export the final Solid that was created from the sketch on the face, since it will include all the parent faces and Solids. | ||||
|  | ||||
| ```js | ||||
| startSketchOn(data: SketchData, tag?: FaceTag) -> SketchSurface | ||||
|  | ||||
							
								
								
									
										44
									
								
								docs/kcl/std-math-cos.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl/std-math-cos.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl/std-math-sin.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl/std-math-sin.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										44
									
								
								docs/kcl/std-math-tan.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										44
									
								
								docs/kcl/std-math-tan.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										40309
									
								
								docs/kcl/std.json
									
									
									
									
									
								
							
							
						
						
									
										40309
									
								
								docs/kcl/std.json
									
									
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @ -24,7 +24,7 @@ sweep(sketch: Sketch, path: SweepPath, sectional?: bool, tolerance?: number) -> | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces. | ||||
| [`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -21,7 +21,7 @@ tangentToEnd(tag: TagIdentifier) -> number | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| `number`  | ||||
| `number` | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user
	