Move sketch functions to KCL; remove Rust decl dead code (#7335)
Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
		| @ -1,24 +1,23 @@ | ||||
| --- | ||||
| title: "appearance::hexString" | ||||
| subtitle: "Function in std::appearance" | ||||
| excerpt: "" | ||||
| excerpt: "Build a color from its red, green and blue components. These must be between 0 and 255." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Build a color from its red, green and blue components. These must be between 0 and 255. | ||||
|  | ||||
| ```kcl | ||||
| appearance::hexString(@rgb: [number(_); 3]): string | ||||
| ``` | ||||
|  | ||||
| Build a color from its red, green and blue components. | ||||
| These must be between 0 and 255. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `rgb` | [`[number(_); 3]`](/docs/kcl-std/types/std-types-number) |  | Yes | | ||||
| | `rgb` | [`[number(_); 3]`](/docs/kcl-std/types/std-types-number) | The red, blue and green components of the color. Must be between 0 and 255. | Yes | | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "reduce" | ||||
| subtitle: "Function in std::array" | ||||
| excerpt: "" | ||||
| excerpt: "Take a starting value. Then, for each element of an array, calculate the next value, using the previous value and the element." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Take a starting value. Then, for each element of an array, calculate the next value, using the previous value and the element. | ||||
|  | ||||
| ```kcl | ||||
| reduce( | ||||
| @ -15,8 +15,7 @@ reduce( | ||||
| ): any | ||||
| ``` | ||||
|  | ||||
| Take a starting value. Then, for each element of an array, calculate the next value, | ||||
| using the previous value and the element. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
| @ -28,7 +27,7 @@ using the previous value and the element. | ||||
|  | ||||
| ### Returns | ||||
|  | ||||
| [`any`](/docs/kcl-std/types/std-types-any) | ||||
| [`any`](/docs/kcl-std/types/std-types-any) - The [`any`](/docs/kcl-std/types/std-types-any) type is the type of all possible values in KCL. I.e., if a function accepts an argument with type [`any`](/docs/kcl-std/types/std-types-any), then it can accept any value. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "assert" | ||||
| subtitle: "Function in std" | ||||
| excerpt: "" | ||||
| excerpt: "Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met. If you provide multiple conditions, they will all be checked and all must be met." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met. If you provide multiple conditions, they will all be checked and all must be met. | ||||
|  | ||||
| ```kcl | ||||
| assert( | ||||
| @ -20,8 +20,7 @@ assert( | ||||
| ) | ||||
| ``` | ||||
|  | ||||
| Check a value meets some expected conditions at runtime. Program terminates with an error if conditions aren't met. | ||||
| If you provide multiple conditions, they will all be checked and all must be met. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "polar" | ||||
| subtitle: "Function in std::math" | ||||
| excerpt: "" | ||||
| excerpt: "Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates. | ||||
|  | ||||
| ```kcl | ||||
| polar( | ||||
| @ -14,8 +14,7 @@ polar( | ||||
| ): Point2d | ||||
| ``` | ||||
|  | ||||
| Convert polar/sphere (azimuth, elevation, distance) coordinates to | ||||
| cartesian (x/y/z grid) coordinates. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "rem" | ||||
| subtitle: "Function in std::math" | ||||
| excerpt: "" | ||||
| excerpt: "Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too. | ||||
|  | ||||
| ```kcl | ||||
| rem( | ||||
| @ -14,8 +14,7 @@ rem( | ||||
| ): number | ||||
| ``` | ||||
|  | ||||
| Compute the remainder after dividing `num` by `div`. | ||||
| If `num` is negative, the result will be too. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -10,13 +10,13 @@ Draw a line segment relative to the current origin using the polar measure of so | ||||
| ```kcl | ||||
| angledLine( | ||||
|   @sketch: Sketch, | ||||
|   angle: number, | ||||
|   length?: number, | ||||
|   lengthX?: number, | ||||
|   lengthY?: number, | ||||
|   endAbsoluteX?: number, | ||||
|   endAbsoluteY?: number, | ||||
|   tag?: TagDeclarator, | ||||
|   angle: number(Angle), | ||||
|   length?: number(Length), | ||||
|   lengthX?: number(Length), | ||||
|   lengthY?: number(Length), | ||||
|   endAbsoluteX?: number(Length), | ||||
|   endAbsoluteY?: number(Length), | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| @ -27,13 +27,13 @@ angledLine( | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `angle` | [`number`](/docs/kcl-std/types/std-types-number) | Which angle should the line be drawn at? | Yes | | ||||
| | `length` | [`number`](/docs/kcl-std/types/std-types-number) | Draw the line this distance along the given angle. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `lengthX` | [`number`](/docs/kcl-std/types/std-types-number) | Draw the line this distance along the X axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `lengthY` | [`number`](/docs/kcl-std/types/std-types-number) | Draw the line this distance along the Y axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `endAbsoluteX` | [`number`](/docs/kcl-std/types/std-types-number) | Draw the line along the given angle until it reaches this point along the X axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `endAbsoluteY` | [`number`](/docs/kcl-std/types/std-types-number) | Draw the line along the given angle until it reaches this point along the Y axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this line | No | | ||||
| | `angle` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Which angle should the line be drawn at? | Yes | | ||||
| | `length` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Draw the line this distance along the given angle. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `lengthX` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Draw the line this distance along the X axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `lengthY` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Draw the line this distance along the Y axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `endAbsoluteX` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Draw the line along the given angle until it reaches this point along the X axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | `endAbsoluteY` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Draw the line along the given angle until it reaches this point along the Y axis. Only one of `length`, `lengthX`, `lengthY`, `endAbsoluteX`, `endAbsoluteY` can be given. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this line. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -46,7 +46,10 @@ angledLine( | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> yLine(endAbsolute = 15) | ||||
|   |> angledLine(angle = 30, length = 15) | ||||
|   |> angledLine( | ||||
|     angle = 30, | ||||
|     length = 15, | ||||
|   ) | ||||
|   |> line(end = [8, -10]) | ||||
|   |> yLine(endAbsolute = 0) | ||||
|   |> close() | ||||
| @ -10,10 +10,10 @@ Draw an angled line from the current origin, constructing a line segment such th | ||||
| ```kcl | ||||
| angledLineThatIntersects( | ||||
|   @sketch: Sketch, | ||||
|   angle: number, | ||||
|   intersectTag: TagIdentifier, | ||||
|   offset?: number, | ||||
|   tag?: TagDeclarator, | ||||
|   angle: number(Angle), | ||||
|   intersectTag: tag, | ||||
|   offset?: number(Length), | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| @ -24,10 +24,10 @@ angledLineThatIntersects( | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `angle` | [`number`](/docs/kcl-std/types/std-types-number) | Which angle should the line be drawn at? | Yes | | ||||
| | `intersectTag` | [`TagIdentifier`](/docs/kcl-lang/types#TagIdentifier) | The tag of the line to intersect with | Yes | | ||||
| | `offset` | [`number`](/docs/kcl-std/types/std-types-number) | The offset from the intersecting line. Defaults to 0. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this line | No | | ||||
| | `angle` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Which angle should the line be drawn at? | Yes | | ||||
| | `intersectTag` | [`tag`](/docs/kcl-std/types/std-types-tag) | The tag of the line to intersect with. | Yes | | ||||
| | `offset` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | The offset from the intersecting line. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this line. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -42,7 +42,11 @@ exampleSketch = startSketchOn(XZ) | ||||
|   |> line(endAbsolute = [5, 10]) | ||||
|   |> line(endAbsolute = [-10, 10], tag = $lineToIntersect) | ||||
|   |> line(endAbsolute = [0, 20]) | ||||
|   |> angledLineThatIntersects(angle = 80, intersectTag = lineToIntersect, offset = 10) | ||||
|   |> angledLineThatIntersects( | ||||
|        angle = 80, | ||||
|        intersectTag = lineToIntersect, | ||||
|        offset = 10, | ||||
|      ) | ||||
|   |> close() | ||||
| 
 | ||||
| example = extrude(exampleSketch, length = 10) | ||||
| @ -10,32 +10,37 @@ Draw a curved line segment along an imaginary circle. | ||||
| ```kcl | ||||
| arc( | ||||
|   @sketch: Sketch, | ||||
|   angleStart?: number, | ||||
|   angleEnd?: number, | ||||
|   radius?: number, | ||||
|   diameter?: number, | ||||
|   angleStart?: number(Angle), | ||||
|   angleEnd?: number(Angle), | ||||
|   radius?: number(Length), | ||||
|   diameter?: number(Length), | ||||
|   interiorAbsolute?: Point2d, | ||||
|   endAbsolute?: Point2d, | ||||
|   tag?: TagDeclarator, | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| The arc is constructed such that the current position of the sketch is placed along an imaginary circle of the specified radius, at angleStart degrees. The resulting arc is the segment of the imaginary circle from that origin point to angleEnd, radius away from the center of the imaginary circle. | ||||
| The arc is constructed such that the current position of the sketch is | ||||
| placed along an imaginary circle of the specified radius, at angleStart | ||||
| degrees. The resulting arc is the segment of the imaginary circle from | ||||
| that origin point to angleEnd, radius away from the center of the imaginary | ||||
| circle. | ||||
| 
 | ||||
| Unless this makes a lot of sense and feels like what you're looking for to construct your shape, you're likely looking for tangentialArc. | ||||
| Unless this makes a lot of sense and feels like what you're looking | ||||
| for to construct your shape, you're likely looking for tangentialArc. | ||||
| 
 | ||||
| ### Arguments | ||||
| 
 | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `angleStart` | [`number`](/docs/kcl-std/types/std-types-number) | Where along the circle should this arc start? | No | | ||||
| | `angleEnd` | [`number`](/docs/kcl-std/types/std-types-number) | Where along the circle should this arc end? | No | | ||||
| | `radius` | [`number`](/docs/kcl-std/types/std-types-number) | How large should the circle be? Incompatible with `diameter`. | No | | ||||
| | `diameter` | [`number`](/docs/kcl-std/types/std-types-number) | How large should the circle be? Incompatible with `radius`. | No | | ||||
| | `interiorAbsolute` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Any point between the arc's start and end? Requires `endAbsolute`. Incompatible with `angleStart` or `angleEnd` | No | | ||||
| | `endAbsolute` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Where should this arc end? Requires `interiorAbsolute`. Incompatible with `angleStart` or `angleEnd` | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this line | No | | ||||
| | `angleStart` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Where along the circle should this arc start? | No | | ||||
| | `angleEnd` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Where along the circle should this arc end? | No | | ||||
| | `radius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | How large should the circle be? Incompatible with `diameter`. | No | | ||||
| | `diameter` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | How large should the circle be? Incompatible with `radius`. | No | | ||||
| | `interiorAbsolute` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Any point between the arc's start and end? Requires `endAbsolute`. Incompatible with `angleStart` or `angleEnd`. | No | | ||||
| | `endAbsolute` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Where should this arc end? Requires `interiorAbsolute`. Incompatible with `angleStart` or `angleEnd`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this arc. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -48,7 +53,11 @@ Unless this makes a lot of sense and feels like what you're looking for to const | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> line(end = [10, 0]) | ||||
|   |> arc(angleStart = 0, angleEnd = 280, radius = 16) | ||||
|   |> arc( | ||||
|        angleStart = 0, | ||||
|        angleEnd = 280, | ||||
|        radius = 16 | ||||
|      ) | ||||
|   |> close() | ||||
| example = extrude(exampleSketch, length = 10) | ||||
| ``` | ||||
| @ -58,7 +67,10 @@ example = extrude(exampleSketch, length = 10) | ||||
| ```kcl | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> arc(endAbsolute = [10, 0], interiorAbsolute = [5, 5]) | ||||
|   |> arc( | ||||
|         endAbsolute = [10,0], | ||||
|         interiorAbsolute = [5,5] | ||||
|      ) | ||||
|   |> close() | ||||
| example = extrude(exampleSketch, length = 10) | ||||
| ``` | ||||
							
								
								
									
										74
									
								
								docs/kcl-std/functions/std-sketch-bezierCurve.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										74
									
								
								docs/kcl-std/functions/std-sketch-bezierCurve.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "circle" | ||||
| subtitle: "Function in std::sketch" | ||||
| excerpt: "" | ||||
| excerpt: "Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point. | ||||
|  | ||||
| ```kcl | ||||
| circle( | ||||
| @ -17,8 +17,7 @@ circle( | ||||
| ): Sketch | ||||
| ``` | ||||
|  | ||||
| Construct a 2-dimensional circle, of the specified radius, centered at | ||||
| the provided (x, y) origin point. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "extrude" | ||||
| subtitle: "Function in std::sketch" | ||||
| excerpt: "" | ||||
| excerpt: "Extend a 2-dimensional sketch through a third dimension in order to create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Extend a 2-dimensional sketch through a third dimension in order to create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid. | ||||
|  | ||||
| ```kcl | ||||
| extrude( | ||||
| @ -18,9 +18,6 @@ extrude( | ||||
| ): [Solid; 1+] | ||||
| ``` | ||||
|  | ||||
| Extend a 2-dimensional sketch through a third dimension in order to | ||||
| create new 3-dimensional volume, or if extruded into an existing volume,cut into an existing solid. | ||||
|  | ||||
| You can provide more than one sketch to extrude, and they will all be | ||||
| extruded in the same direction. | ||||
|  | ||||
|  | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -12,7 +12,7 @@ line( | ||||
|   @sketch: Sketch, | ||||
|   endAbsolute?: Point2d, | ||||
|   end?: Point2d, | ||||
|   tag?: TagDeclarator, | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| @ -25,7 +25,7 @@ line( | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `endAbsolute` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Which absolute point should this line go to? Incompatible with `end`. | No | | ||||
| | `end` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | How far away (along the X and Y axes) should this line go? Incompatible with `endAbsolute`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this line | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this line. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "patternCircular2d" | ||||
| subtitle: "Function in std::sketch" | ||||
| excerpt: "" | ||||
| excerpt: "Repeat a 2-dimensional sketch some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orientation of the solid with respect to the center of the circle is maintained." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Repeat a 2-dimensional sketch some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orientation of the solid with respect to the center of the circle is maintained. | ||||
|  | ||||
| ```kcl | ||||
| patternCircular2d( | ||||
| @ -18,9 +18,7 @@ patternCircular2d( | ||||
| ): [Sketch; 1+] | ||||
| ``` | ||||
|  | ||||
| Repeat a 2-dimensional sketch some number of times along a partial or | ||||
| complete circle some specified number of times. Each object mayadditionally be rotated along the circle, ensuring orientation of the | ||||
| solid with respect to the center of the circle is maintained. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "patternLinear2d" | ||||
| subtitle: "Function in std::sketch" | ||||
| excerpt: "" | ||||
| excerpt: "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times. | ||||
|  | ||||
| ```kcl | ||||
| patternLinear2d( | ||||
| @ -17,8 +17,7 @@ patternLinear2d( | ||||
| ): [Sketch; 1+] | ||||
| ``` | ||||
|  | ||||
| Repeat a 2-dimensional sketch along some dimension, with a dynamic amount | ||||
| of distance between each repetition, some specified number of times. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -9,9 +9,9 @@ Start a new profile at a given point. | ||||
| 
 | ||||
| ```kcl | ||||
| startProfile( | ||||
|   @sketchSurface: Plane | Face, | ||||
|   @startProfileOn: Plane | Face, | ||||
|   at: Point2d, | ||||
|   tag?: TagDeclarator, | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| @ -21,9 +21,9 @@ startProfile( | ||||
| 
 | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `sketchSurface` | [`Plane`](/docs/kcl-std/types/std-types-Plane) or [`Face`](/docs/kcl-std/types/std-types-Face) | What to start the profile on | Yes | | ||||
| | `startProfileOn` | [`Plane`](/docs/kcl-std/types/std-types-Plane) or [`Face`](/docs/kcl-std/types/std-types-Face) | What to start the profile on. | Yes | | ||||
| | `at` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Where to start the profile. An absolute point. | Yes | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Tag this first starting point | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Tag this first starting point. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										67
									
								
								docs/kcl-std/functions/std-sketch-subtract2d.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										67
									
								
								docs/kcl-std/functions/std-sketch-subtract2d.md
									
									
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| @ -12,14 +12,18 @@ tangentialArc( | ||||
|   @sketch: Sketch, | ||||
|   endAbsolute?: Point2d, | ||||
|   end?: Point2d, | ||||
|   radius?: number, | ||||
|   diameter?: number, | ||||
|   angle?: number, | ||||
|   tag?: TagDeclarator, | ||||
|   radius?: number(Length), | ||||
|   diameter?: number(Length), | ||||
|   angle?: number(Angle), | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| When using radius and angle, draw a curved line segment along part of an imaginary circle. The arc is constructed such that the last line segment is placed tangent to the imaginary circle of the specified radius. The resulting arc is the segment of the imaginary circle from that tangent point for 'angle' degrees along the imaginary circle. | ||||
| When using radius and angle, draw a curved line segment along part of an | ||||
| imaginary circle. The arc is constructed such that the last line segment is | ||||
| placed tangent to the imaginary circle of the specified radius. The | ||||
| resulting arc is the segment of the imaginary circle from that tangent point | ||||
| for 'angle' degrees along the imaginary circle. | ||||
| 
 | ||||
| ### Arguments | ||||
| 
 | ||||
| @ -28,10 +32,10 @@ When using radius and angle, draw a curved line segment along part of an imagina | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `endAbsolute` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | Which absolute point should this arc go to? Incompatible with `end`, `radius`, and `offset`. | No | | ||||
| | `end` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | How far away (along the X and Y axes) should this arc go? Incompatible with `endAbsolute`, `radius`, and `offset`. | No | | ||||
| | `radius` | [`number`](/docs/kcl-std/types/std-types-number) | Radius of the imaginary circle. `angle` must be given. Incompatible with `end` and `endAbsolute` and `diameter`. | No | | ||||
| | `diameter` | [`number`](/docs/kcl-std/types/std-types-number) | Diameter of the imaginary circle. `angle` must be given. Incompatible with `end` and `endAbsolute` and `radius`. | No | | ||||
| | `angle` | [`number`](/docs/kcl-std/types/std-types-number) | Offset of the arc in degrees. `radius` must be given. Incompatible with `end` and `endAbsolute`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this arc | No | | ||||
| | `radius` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Radius of the imaginary circle. `angle` must be given. Incompatible with `end` and `endAbsolute` and `diameter`. | No | | ||||
| | `diameter` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Diameter of the imaginary circle. `angle` must be given. Incompatible with `end` and `endAbsolute` and `radius`. | No | | ||||
| | `angle` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | Offset of the arc. `radius` must be given. Incompatible with `end` and `endAbsolute`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this arc. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -43,7 +47,10 @@ When using radius and angle, draw a curved line segment along part of an imagina | ||||
| ```kcl | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> angledLine(angle = 45, length = 10) | ||||
|   |> angledLine( | ||||
|     angle = 45, | ||||
|     length = 10, | ||||
|   ) | ||||
|   |> tangentialArc(end = [0, -10]) | ||||
|   |> line(end = [-10, 0]) | ||||
|   |> close() | ||||
| @ -56,7 +63,10 @@ example = extrude(exampleSketch, length = 10) | ||||
| ```kcl | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> angledLine(angle = 60, length = 10) | ||||
|   |> angledLine( | ||||
|     angle = 60, | ||||
|     length = 10, | ||||
|   ) | ||||
|   |> tangentialArc(endAbsolute = [15, 15]) | ||||
|   |> line(end = [10, -15]) | ||||
|   |> close() | ||||
| @ -69,9 +79,15 @@ example = extrude(exampleSketch, length = 10) | ||||
| ```kcl | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> angledLine(angle = 60, length = 10) | ||||
|   |> angledLine( | ||||
|     angle = 60, | ||||
|     length = 10, | ||||
|   ) | ||||
|   |> tangentialArc(radius = 10, angle = -120) | ||||
|   |> angledLine(angle = -60, length = 10) | ||||
|   |> angledLine( | ||||
|     angle = -60, | ||||
|     length = 10, | ||||
|   ) | ||||
|   |> close() | ||||
| 
 | ||||
| example = extrude(exampleSketch, length = 10) | ||||
| @ -10,9 +10,9 @@ Draw a line relative to the current origin to a specified distance away from the | ||||
| ```kcl | ||||
| xLine( | ||||
|   @sketch: Sketch, | ||||
|   length?: number, | ||||
|   endAbsolute?: number, | ||||
|   tag?: TagDeclarator, | ||||
|   length?: number(Length), | ||||
|   endAbsolute?: number(Length), | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| @ -23,9 +23,9 @@ xLine( | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `length` | [`number`](/docs/kcl-std/types/std-types-number) | How far away along the X axis should this line go? Incompatible with `endAbsolute`. | No | | ||||
| | `endAbsolute` | [`number`](/docs/kcl-std/types/std-types-number) | Which absolute X value should this line go to? Incompatible with `length`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this line | No | | ||||
| | `length` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | How far away along the X axis should this line go? Incompatible with `endAbsolute`. | No | | ||||
| | `endAbsolute` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Which absolute X value should this line go to? Incompatible with `length`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this line. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -38,10 +38,16 @@ xLine( | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> xLine(length = 15) | ||||
|   |> angledLine(angle = 80, length = 15) | ||||
|   |> angledLine( | ||||
|     angle = 80, | ||||
|     length = 15, | ||||
|   ) | ||||
|   |> line(end = [8, -10]) | ||||
|   |> xLine(length = 10) | ||||
|   |> angledLine(angle = 120, length = 30) | ||||
|   |> angledLine( | ||||
|     angle = 120, | ||||
|     length = 30, | ||||
|   ) | ||||
|   |> xLine(length = -15) | ||||
|   |> close() | ||||
| 
 | ||||
| @ -10,9 +10,9 @@ Draw a line relative to the current origin to a specified distance away from the | ||||
| ```kcl | ||||
| yLine( | ||||
|   @sketch: Sketch, | ||||
|   length?: number, | ||||
|   endAbsolute?: number, | ||||
|   tag?: TagDeclarator, | ||||
|   length?: number(Length), | ||||
|   endAbsolute?: number(Length), | ||||
|   tag?: tag, | ||||
| ): Sketch | ||||
| ``` | ||||
| 
 | ||||
| @ -23,9 +23,9 @@ yLine( | ||||
| | Name | Type | Description | Required | | ||||
| |----------|------|-------------|----------| | ||||
| | `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes | | ||||
| | `length` | [`number`](/docs/kcl-std/types/std-types-number) | How far away along the Y axis should this line go? Incompatible with `endAbsolute`. | No | | ||||
| | `endAbsolute` | [`number`](/docs/kcl-std/types/std-types-number) | Which absolute Y value should this line go to? Incompatible with `length`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | Create a new tag which refers to this line | No | | ||||
| | `length` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | How far away along the Y axis should this line go? Incompatible with `endAbsolute`. | No | | ||||
| | `endAbsolute` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | Which absolute Y value should this line go to? Incompatible with `length`. | No | | ||||
| | [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this line. | No | | ||||
| 
 | ||||
| ### Returns | ||||
| 
 | ||||
| @ -38,7 +38,10 @@ yLine( | ||||
| exampleSketch = startSketchOn(XZ) | ||||
|   |> startProfile(at = [0, 0]) | ||||
|   |> yLine(length = 15) | ||||
|   |> angledLine(angle = 30, length = 15) | ||||
|   |> angledLine( | ||||
|     angle = 30, | ||||
|     length = 15, | ||||
|   ) | ||||
|   |> line(end = [8, -10]) | ||||
|   |> yLine(length = -5) | ||||
|   |> close() | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "intersect" | ||||
| subtitle: "Function in std::solid" | ||||
| excerpt: "" | ||||
| excerpt: "Intersect returns the shared volume between multiple solids, preserving only overlapping regions." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Intersect returns the shared volume between multiple solids, preserving only overlapping regions. | ||||
|  | ||||
| ```kcl | ||||
| intersect( | ||||
| @ -14,8 +14,6 @@ intersect( | ||||
| ): [Solid; 1+] | ||||
| ``` | ||||
|  | ||||
| Intersect returns the shared volume between multiple solids, preserving only | ||||
| overlapping regions. | ||||
| Intersect computes the geometric intersection of multiple solid bodies, | ||||
| returning a new solid representing the volume that is common to all input | ||||
| solids. This operation is useful for determining shared material regions, | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "patternCircular3d" | ||||
| subtitle: "Function in std::solid" | ||||
| excerpt: "" | ||||
| excerpt: "Repeat a 3-dimensional solid some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orientation of the solid with respect to the center of the circle is maintained." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Repeat a 3-dimensional solid some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orientation of the solid with respect to the center of the circle is maintained. | ||||
|  | ||||
| ```kcl | ||||
| patternCircular3d( | ||||
| @ -19,9 +19,7 @@ patternCircular3d( | ||||
| ): [Solid; 1+] | ||||
| ``` | ||||
|  | ||||
| Repeat a 3-dimensional solid some number of times along a partial or | ||||
| complete circle some specified number of times. Each object mayadditionally be rotated along the circle, ensuring orientation of the | ||||
| solid with respect to the center of the circle is maintained. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "patternLinear3d" | ||||
| subtitle: "Function in std::solid" | ||||
| excerpt: "" | ||||
| excerpt: "Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times. | ||||
|  | ||||
| ```kcl | ||||
| patternLinear3d( | ||||
| @ -17,8 +17,7 @@ patternLinear3d( | ||||
| ): [Solid; 1+] | ||||
| ``` | ||||
|  | ||||
| Repeat a 3-dimensional solid along a linear path, with a dynamic amount | ||||
| of distance between each repetition, some specified number of times. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -1,11 +1,11 @@ | ||||
| --- | ||||
| title: "shell" | ||||
| subtitle: "Function in std::solid" | ||||
| excerpt: "" | ||||
| excerpt: "Remove volume from a 3-dimensional shape such that a wall of the provided thickness remains, taking volume starting at the provided face, leaving it open in that direction." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
|  | ||||
| Remove volume from a 3-dimensional shape such that a wall of the provided thickness remains, taking volume starting at the provided face, leaving it open in that direction. | ||||
|  | ||||
| ```kcl | ||||
| shell( | ||||
| @ -15,8 +15,7 @@ shell( | ||||
| ): [Solid] | ||||
| ``` | ||||
|  | ||||
| Remove volume from a 3-dimensional shape such that a wall of the | ||||
| provided thickness remains, taking volume starting at the providedface, leaving it open in that direction. | ||||
|  | ||||
|  | ||||
| ### Arguments | ||||
|  | ||||
|  | ||||
| @ -47,30 +47,30 @@ layout: manual | ||||
|   * [`sqrt`](/docs/kcl-std/functions/std-math-sqrt) | ||||
|   * [`tan`](/docs/kcl-std/functions/std-math-tan) | ||||
| * [**std::sketch**](/docs/kcl-std/modules/std-sketch) | ||||
|   * [`angledLine`](/docs/kcl-std/angledLine) | ||||
|   * [`angledLineThatIntersects`](/docs/kcl-std/angledLineThatIntersects) | ||||
|   * [`arc`](/docs/kcl-std/arc) | ||||
|   * [`bezierCurve`](/docs/kcl-std/bezierCurve) | ||||
|   * [`angledLine`](/docs/kcl-std/functions/std-sketch-angledLine) | ||||
|   * [`angledLineThatIntersects`](/docs/kcl-std/functions/std-sketch-angledLineThatIntersects) | ||||
|   * [`arc`](/docs/kcl-std/functions/std-sketch-arc) | ||||
|   * [`bezierCurve`](/docs/kcl-std/functions/std-sketch-bezierCurve) | ||||
|   * [`circle`](/docs/kcl-std/functions/std-sketch-circle) | ||||
|   * [`circleThreePoint`](/docs/kcl-std/functions/std-sketch-circleThreePoint) | ||||
|   * [`close`](/docs/kcl-std/close) | ||||
|   * [`close`](/docs/kcl-std/functions/std-sketch-close) | ||||
|   * [`extrude`](/docs/kcl-std/functions/std-sketch-extrude) | ||||
|   * [`getCommonEdge`](/docs/kcl-std/functions/std-sketch-getCommonEdge) | ||||
|   * [`getNextAdjacentEdge`](/docs/kcl-std/functions/std-sketch-getNextAdjacentEdge) | ||||
|   * [`getOppositeEdge`](/docs/kcl-std/functions/std-sketch-getOppositeEdge) | ||||
|   * [`getPreviousAdjacentEdge`](/docs/kcl-std/functions/std-sketch-getPreviousAdjacentEdge) | ||||
|   * [`involuteCircular`](/docs/kcl-std/involuteCircular) | ||||
|   * [`involuteCircular`](/docs/kcl-std/functions/std-sketch-involuteCircular) | ||||
|   * [`lastSegX`](/docs/kcl-std/functions/std-sketch-lastSegX) | ||||
|   * [`lastSegY`](/docs/kcl-std/functions/std-sketch-lastSegY) | ||||
|   * [`line`](/docs/kcl-std/line) | ||||
|   * [`line`](/docs/kcl-std/functions/std-sketch-line) | ||||
|   * [`loft`](/docs/kcl-std/functions/std-sketch-loft) | ||||
|   * [`patternCircular2d`](/docs/kcl-std/functions/std-sketch-patternCircular2d) | ||||
|   * [`patternLinear2d`](/docs/kcl-std/functions/std-sketch-patternLinear2d) | ||||
|   * [`patternTransform2d`](/docs/kcl-std/functions/std-sketch-patternTransform2d) | ||||
|   * [`polygon`](/docs/kcl-std/functions/std-sketch-polygon) | ||||
|   * [`profileStart`](/docs/kcl-std/profileStart) | ||||
|   * [`profileStartX`](/docs/kcl-std/profileStartX) | ||||
|   * [`profileStartY`](/docs/kcl-std/profileStartY) | ||||
|   * [`profileStart`](/docs/kcl-std/functions/std-sketch-profileStart) | ||||
|   * [`profileStartX`](/docs/kcl-std/functions/std-sketch-profileStartX) | ||||
|   * [`profileStartY`](/docs/kcl-std/functions/std-sketch-profileStartY) | ||||
|   * [`revolve`](/docs/kcl-std/functions/std-sketch-revolve) | ||||
|   * [`segAng`](/docs/kcl-std/functions/std-sketch-segAng) | ||||
|   * [`segEnd`](/docs/kcl-std/functions/std-sketch-segEnd) | ||||
| @ -80,14 +80,14 @@ layout: manual | ||||
|   * [`segStart`](/docs/kcl-std/functions/std-sketch-segStart) | ||||
|   * [`segStartX`](/docs/kcl-std/functions/std-sketch-segStartX) | ||||
|   * [`segStartY`](/docs/kcl-std/functions/std-sketch-segStartY) | ||||
|   * [`startProfile`](/docs/kcl-std/startProfile) | ||||
|   * [`startSketchOn`](/docs/kcl-std/startSketchOn) | ||||
|   * [`subtract2d`](/docs/kcl-std/subtract2d) | ||||
|   * [`startProfile`](/docs/kcl-std/functions/std-sketch-startProfile) | ||||
|   * [`startSketchOn`](/docs/kcl-std/functions/std-sketch-startSketchOn) | ||||
|   * [`subtract2d`](/docs/kcl-std/functions/std-sketch-subtract2d) | ||||
|   * [`sweep`](/docs/kcl-std/functions/std-sketch-sweep) | ||||
|   * [`tangentToEnd`](/docs/kcl-std/functions/std-sketch-tangentToEnd) | ||||
|   * [`tangentialArc`](/docs/kcl-std/tangentialArc) | ||||
|   * [`xLine`](/docs/kcl-std/xLine) | ||||
|   * [`yLine`](/docs/kcl-std/yLine) | ||||
|   * [`tangentialArc`](/docs/kcl-std/functions/std-sketch-tangentialArc) | ||||
|   * [`xLine`](/docs/kcl-std/functions/std-sketch-xLine) | ||||
|   * [`yLine`](/docs/kcl-std/functions/std-sketch-yLine) | ||||
| * [**std::solid**](/docs/kcl-std/modules/std-solid) | ||||
|   * [`appearance`](/docs/kcl-std/functions/std-solid-appearance) | ||||
|   * [`chamfer`](/docs/kcl-std/functions/std-solid-chamfer) | ||||
| @ -144,11 +144,7 @@ layout: manual | ||||
| See also the [types overview](/docs/kcl-lang/types) | ||||
|  | ||||
| * [**Primitive types**](/docs/kcl-lang/types) | ||||
|   * [`End`](/docs/kcl-lang/types#End) | ||||
|   * [`ImportedGeometry`](/docs/kcl-std/types/std-types-ImportedGeometry) | ||||
|   * [`Start`](/docs/kcl-lang/types#Start) | ||||
|   * [`TagDeclarator`](/docs/kcl-lang/types#TagDeclarator) | ||||
|   * [`TagIdentifier`](/docs/kcl-lang/types#TagIdentifier) | ||||
|   * [`any`](/docs/kcl-std/types/std-types-any) | ||||
|   * [`bool`](/docs/kcl-std/types/std-types-bool) | ||||
|   * [`fn`](/docs/kcl-std/types/std-types-fn) | ||||
|  | ||||
| @ -12,30 +12,30 @@ This module contains functions for creating and manipulating sketches, and makin | ||||
|  | ||||
| ## Functions and constants | ||||
|  | ||||
| * [`angledLine`](/docs/kcl-std/angledLine) | ||||
| * [`angledLineThatIntersects`](/docs/kcl-std/angledLineThatIntersects) | ||||
| * [`arc`](/docs/kcl-std/arc) | ||||
| * [`bezierCurve`](/docs/kcl-std/bezierCurve) | ||||
| * [`angledLine`](/docs/kcl-std/functions/std-sketch-angledLine) | ||||
| * [`angledLineThatIntersects`](/docs/kcl-std/functions/std-sketch-angledLineThatIntersects) | ||||
| * [`arc`](/docs/kcl-std/functions/std-sketch-arc) | ||||
| * [`bezierCurve`](/docs/kcl-std/functions/std-sketch-bezierCurve) | ||||
| * [`circle`](/docs/kcl-std/functions/std-sketch-circle) | ||||
| * [`circleThreePoint`](/docs/kcl-std/functions/std-sketch-circleThreePoint) | ||||
| * [`close`](/docs/kcl-std/close) | ||||
| * [`close`](/docs/kcl-std/functions/std-sketch-close) | ||||
| * [`extrude`](/docs/kcl-std/functions/std-sketch-extrude) | ||||
| * [`getCommonEdge`](/docs/kcl-std/functions/std-sketch-getCommonEdge) | ||||
| * [`getNextAdjacentEdge`](/docs/kcl-std/functions/std-sketch-getNextAdjacentEdge) | ||||
| * [`getOppositeEdge`](/docs/kcl-std/functions/std-sketch-getOppositeEdge) | ||||
| * [`getPreviousAdjacentEdge`](/docs/kcl-std/functions/std-sketch-getPreviousAdjacentEdge) | ||||
| * [`involuteCircular`](/docs/kcl-std/involuteCircular) | ||||
| * [`involuteCircular`](/docs/kcl-std/functions/std-sketch-involuteCircular) | ||||
| * [`lastSegX`](/docs/kcl-std/functions/std-sketch-lastSegX) | ||||
| * [`lastSegY`](/docs/kcl-std/functions/std-sketch-lastSegY) | ||||
| * [`line`](/docs/kcl-std/line) | ||||
| * [`line`](/docs/kcl-std/functions/std-sketch-line) | ||||
| * [`loft`](/docs/kcl-std/functions/std-sketch-loft) | ||||
| * [`patternCircular2d`](/docs/kcl-std/functions/std-sketch-patternCircular2d) | ||||
| * [`patternLinear2d`](/docs/kcl-std/functions/std-sketch-patternLinear2d) | ||||
| * [`patternTransform2d`](/docs/kcl-std/functions/std-sketch-patternTransform2d) | ||||
| * [`polygon`](/docs/kcl-std/functions/std-sketch-polygon) | ||||
| * [`profileStart`](/docs/kcl-std/profileStart) | ||||
| * [`profileStartX`](/docs/kcl-std/profileStartX) | ||||
| * [`profileStartY`](/docs/kcl-std/profileStartY) | ||||
| * [`profileStart`](/docs/kcl-std/functions/std-sketch-profileStart) | ||||
| * [`profileStartX`](/docs/kcl-std/functions/std-sketch-profileStartX) | ||||
| * [`profileStartY`](/docs/kcl-std/functions/std-sketch-profileStartY) | ||||
| * [`revolve`](/docs/kcl-std/functions/std-sketch-revolve) | ||||
| * [`segAng`](/docs/kcl-std/functions/std-sketch-segAng) | ||||
| * [`segEnd`](/docs/kcl-std/functions/std-sketch-segEnd) | ||||
| @ -45,12 +45,12 @@ This module contains functions for creating and manipulating sketches, and makin | ||||
| * [`segStart`](/docs/kcl-std/functions/std-sketch-segStart) | ||||
| * [`segStartX`](/docs/kcl-std/functions/std-sketch-segStartX) | ||||
| * [`segStartY`](/docs/kcl-std/functions/std-sketch-segStartY) | ||||
| * [`startProfile`](/docs/kcl-std/startProfile) | ||||
| * [`startSketchOn`](/docs/kcl-std/startSketchOn) | ||||
| * [`subtract2d`](/docs/kcl-std/subtract2d) | ||||
| * [`startProfile`](/docs/kcl-std/functions/std-sketch-startProfile) | ||||
| * [`startSketchOn`](/docs/kcl-std/functions/std-sketch-startSketchOn) | ||||
| * [`subtract2d`](/docs/kcl-std/functions/std-sketch-subtract2d) | ||||
| * [`sweep`](/docs/kcl-std/functions/std-sketch-sweep) | ||||
| * [`tangentToEnd`](/docs/kcl-std/functions/std-sketch-tangentToEnd) | ||||
| * [`tangentialArc`](/docs/kcl-std/tangentialArc) | ||||
| * [`xLine`](/docs/kcl-std/xLine) | ||||
| * [`yLine`](/docs/kcl-std/yLine) | ||||
| * [`tangentialArc`](/docs/kcl-std/functions/std-sketch-tangentialArc) | ||||
| * [`xLine`](/docs/kcl-std/functions/std-sketch-xLine) | ||||
| * [`yLine`](/docs/kcl-std/functions/std-sketch-yLine) | ||||
|  | ||||
|  | ||||
							
								
								
									
										129478
									
								
								docs/kcl-std/std.json
									
									
									
									
									
								
							
							
						
						
									
										129478
									
								
								docs/kcl-std/std.json
									
									
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @ -1,14 +1,13 @@ | ||||
| --- | ||||
| title: "any" | ||||
| subtitle: "Type in std::types" | ||||
| excerpt: "" | ||||
| excerpt: "The [`any`](/docs/kcl-std/types/std-types-any) type is the type of all possible values in KCL. I.e., if a function accepts an argument with type [`any`](/docs/kcl-std/types/std-types-any), then it can accept any value." | ||||
| layout: manual | ||||
| --- | ||||
|  | ||||
| The [`any`](/docs/kcl-std/types/std-types-any) type is the type of all possible values in KCL. I.e., if a function accepts an argument with type [`any`](/docs/kcl-std/types/std-types-any), then it can accept any value. | ||||
|  | ||||
|  | ||||
| The [`any`](/docs/kcl-std/types/std-types-any) type is the type of all possible values in KCL. I.e., if a function accepts an argument | ||||
| with type [`any`](/docs/kcl-std/types/std-types-any), then it can accept any value. | ||||
|  | ||||
|  | ||||
| ### Examples | ||||
|  | ||||
		Reference in New Issue
	
	Block a user