Various hover improvements (#5617)

* Show more info on hover for variables

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Move hover impls to lsp module

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Make hover work on names inside calls, fix doc line breaking, trim docs in tool tips

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Test the new hovers; fix signature syntax

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Hover tips for kwargs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-03-04 22:53:31 +13:00
committed by GitHub
parent 6e57a80c13
commit df278c7e6a
200 changed files with 7888 additions and 4459 deletions

View File

@ -9,7 +9,7 @@ Compute the absolute value of a number.
```js ```js
abs(num: number) -> number abs(num: number): number
``` ```
### Tags ### Tags

View File

@ -9,7 +9,7 @@ Compute the arccosine of a number (in radians).
```js ```js
acos(num: number) -> number acos(num: number): number
``` ```
### Tags ### Tags

View File

@ -13,7 +13,7 @@ angleToMatchLengthX(
tag: TagIdentifier, tag: TagIdentifier,
to: number, to: number,
sketch: Sketch, sketch: Sketch,
) -> number ): number
``` ```

View File

@ -13,7 +13,7 @@ angleToMatchLengthY(
tag: TagIdentifier, tag: TagIdentifier,
to: number, to: number,
sketch: Sketch, sketch: Sketch,
) -> number ): number
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "angledLine" title: "angledLine"
excerpt: "Draw a line segment relative to the current origin using the polar" excerpt: "Draw a line segment relative to the current origin using the polar measure of some angle and distance."
layout: manual layout: manual
--- ---
Draw a line segment relative to the current origin using the polar Draw a line segment relative to the current origin using the polar measure of some angle and distance.
measure of some angle and distance.
```js ```js
angledLine( angledLine(
data: AngledLineData, data: AngledLineData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "angledLineOfXLength" title: "angledLineOfXLength"
excerpt: "Create a line segment from the current 2-dimensional sketch origin" excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'x' dimension."
layout: manual layout: manual
--- ---
Create a line segment from the current 2-dimensional sketch origin Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'x' dimension.
along some angle (in degrees) for some relative length in the 'x' dimension.
```js ```js
angledLineOfXLength( angledLineOfXLength(
data: AngledLineData, data: AngledLineData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "angledLineOfYLength" title: "angledLineOfYLength"
excerpt: "Create a line segment from the current 2-dimensional sketch origin" excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'y' dimension."
layout: manual layout: manual
--- ---
Create a line segment from the current 2-dimensional sketch origin Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'y' dimension.
along some angle (in degrees) for some relative length in the 'y' dimension.
```js ```js
angledLineOfYLength( angledLineOfYLength(
data: AngledLineData, data: AngledLineData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "angledLineThatIntersects" title: "angledLineThatIntersects"
excerpt: "Draw an angled line from the current origin, constructing a line segment" excerpt: "Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment."
layout: manual layout: manual
--- ---
Draw an angled line from the current origin, constructing a line segment Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment.
such that the newly created line intersects the desired target line segment.
```js ```js
angledLineThatIntersects( angledLineThatIntersects(
data: AngledLineThatIntersectsData, data: AngledLineThatIntersectsData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "angledLineToX" title: "angledLineToX"
excerpt: "Create a line segment from the current 2-dimensional sketch origin" excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension."
layout: manual layout: manual
--- ---
Create a line segment from the current 2-dimensional sketch origin Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
```js ```js
angledLineToX( angledLineToX(
data: AngledLineToData, data: AngledLineToData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "angledLineToY" title: "angledLineToY"
excerpt: "Create a line segment from the current 2-dimensional sketch origin" excerpt: "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension."
layout: manual layout: manual
--- ---
Create a line segment from the current 2-dimensional sketch origin Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
```js ```js
angledLineToY( angledLineToY(
data: AngledLineToData, data: AngledLineToData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -14,7 +14,7 @@ appearance(
color: String, color: String,
metalness?: number, metalness?: number,
roughness?: number, roughness?: number,
) -> SolidSet ): SolidSet
``` ```

View File

@ -15,7 +15,7 @@ arc(
data: ArcData, data: ArcData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,10 +1,10 @@
--- ---
title: "arcTo" title: "arcTo"
excerpt: "Draw a 3 point arc." excerpt: "Draw a three point arc."
layout: manual layout: manual
--- ---
Draw a 3 point arc. Draw a three point arc.
The arc is constructed such that the start point is the current position of the sketch and two more points defined as the end and interior point. The interior point is placed between the start point and end point. The radius of the arc will be controlled by how far the interior point is placed from the start and end. The arc is constructed such that the start point is the current position of the sketch and two more points defined as the end and interior point. The interior point is placed between the start point and end point. The radius of the arc will be controlled by how far the interior point is placed from the start and end.
@ -13,7 +13,7 @@ arcTo(
data: ArcToData, data: ArcToData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -9,7 +9,7 @@ Compute the arcsine of a number (in radians).
```js ```js
asin(num: number) -> number asin(num: number): number
``` ```
### Tags ### Tags

View File

@ -1,18 +1,18 @@
--- ---
title: "assert" title: "assert"
excerpt: "Check a value at runtime, and raise an error if the argument provided" excerpt: "Check a value at runtime, and raise an error if the argument provided is false."
layout: manual layout: manual
--- ---
Check a value at runtime, and raise an error if the argument provided Check a value at runtime, and raise an error if the argument provided is false.
is false.
```js ```js
assert( assert(
data: bool, data: bool,
message: string, message: string,
) -> () ): ()
``` ```

View File

@ -1,12 +1,12 @@
--- ---
title: "assertEqual" title: "assertEqual"
excerpt: "Check that a numerical value equals another at runtime," excerpt: "Check that a numerical value equals another at runtime, otherwise raise an error."
layout: manual layout: manual
--- ---
Check that a numerical value equals another at runtime, Check that a numerical value equals another at runtime, otherwise raise an error.
otherwise raise an error.
```js ```js
assertEqual( assertEqual(
@ -14,7 +14,7 @@ assertEqual(
right: number, right: number,
epsilon: number, epsilon: number,
message: string, message: string,
) -> () ): ()
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "assertGreaterThan" title: "assertGreaterThan"
excerpt: "Check that a numerical value is greater than another at runtime," excerpt: "Check that a numerical value is greater than another at runtime, otherwise raise an error."
layout: manual layout: manual
--- ---
Check that a numerical value is greater than another at runtime, Check that a numerical value is greater than another at runtime, otherwise raise an error.
otherwise raise an error.
```js ```js
assertGreaterThan( assertGreaterThan(
left: number, left: number,
right: number, right: number,
message: string, message: string,
) -> () ): ()
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "assertGreaterThanOrEq" title: "assertGreaterThanOrEq"
excerpt: "Check that a numerical value is greater than or equal to another at runtime," excerpt: "Check that a numerical value is greater than or equal to another at runtime, otherwise raise an error."
layout: manual layout: manual
--- ---
Check that a numerical value is greater than or equal to another at runtime, Check that a numerical value is greater than or equal to another at runtime, otherwise raise an error.
otherwise raise an error.
```js ```js
assertGreaterThanOrEq( assertGreaterThanOrEq(
left: number, left: number,
right: number, right: number,
message: string, message: string,
) -> () ): ()
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "assertLessThan" title: "assertLessThan"
excerpt: "Check that a numerical value is less than to another at runtime," excerpt: "Check that a numerical value is less than to another at runtime, otherwise raise an error."
layout: manual layout: manual
--- ---
Check that a numerical value is less than to another at runtime, Check that a numerical value is less than to another at runtime, otherwise raise an error.
otherwise raise an error.
```js ```js
assertLessThan( assertLessThan(
left: number, left: number,
right: number, right: number,
message: string, message: string,
) -> () ): ()
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "assertLessThanOrEq" title: "assertLessThanOrEq"
excerpt: "Check that a numerical value is less than or equal to another at runtime," excerpt: "Check that a numerical value is less than or equal to another at runtime, otherwise raise an error."
layout: manual layout: manual
--- ---
Check that a numerical value is less than or equal to another at runtime, Check that a numerical value is less than or equal to another at runtime, otherwise raise an error.
otherwise raise an error.
```js ```js
assertLessThanOrEq( assertLessThanOrEq(
left: number, left: number,
right: number, right: number,
message: string, message: string,
) -> () ): ()
``` ```

View File

@ -9,7 +9,7 @@ Compute the arctangent of a number (in radians).
```js ```js
atan(num: number) -> number atan(num: number): number
``` ```
### Tags ### Tags

View File

@ -12,7 +12,7 @@ Compute the four quadrant arctangent of Y and X (in radians).
atan2( atan2(
y: number, y: number,
x: number, x: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -1,19 +1,19 @@
--- ---
title: "bezierCurve" title: "bezierCurve"
excerpt: "Draw a smooth, continuous, curved line segment from the current origin to" excerpt: "Draw a smooth, continuous, curved line segment from the current origin to the desired (x, y), using a number of control points to shape the curve's shape."
layout: manual layout: manual
--- ---
Draw a smooth, continuous, curved line segment from the current origin to Draw a smooth, continuous, curved line segment from the current origin to the desired (x, y), using a number of control points to shape the curve's shape.
the desired (x, y), using a number of control points to shape the curve's shape.
```js ```js
bezierCurve( bezierCurve(
data: BezierData, data: BezierData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -9,7 +9,7 @@ Compute the smallest integer greater than or equal to a number.
```js ```js
ceil(num: number) -> number ceil(num: number): number
``` ```
### Tags ### Tags

View File

@ -14,7 +14,7 @@ chamfer(
length: number, length: number,
tags: [EdgeReference], tags: [EdgeReference],
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Solid ): Solid
``` ```

View File

@ -1,12 +1,12 @@
--- ---
title: "circle" title: "circle"
excerpt: "Construct a 2-dimensional circle, of the specified radius, centered at" excerpt: "Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point."
layout: manual layout: manual
--- ---
Construct a 2-dimensional circle, of the specified radius, centered at Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point.
the provided (x, y) origin point.
```js ```js
circle( circle(
@ -14,7 +14,7 @@ circle(
center: [number], center: [number],
radius: number, radius: number,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -15,7 +15,7 @@ circleThreePoint(
p3: [number], p3: [number],
sketchSurfaceOrGroup: SketchOrSurface, sketchSurfaceOrGroup: SketchOrSurface,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,18 +1,18 @@
--- ---
title: "close" title: "close"
excerpt: "Construct a line segment from the current origin back to the profile's" excerpt: "Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended."
layout: manual layout: manual
--- ---
Construct a line segment from the current origin back to the profile's Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended.
origin, ensuring the resulting 2-dimensional sketch is not open-ended.
```js ```js
close( close(
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `0.39
We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters. We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters.
```js ```js
cm() -> number cm(): number
``` ```
### Tags ### Tags

View File

@ -11,7 +11,7 @@ Return the value of Eulers number `e`.
**DEPRECATED** use the constant E **DEPRECATED** use the constant E
```js ```js
e() -> number e(): number
``` ```
### Tags ### Tags

View File

@ -1,18 +1,18 @@
--- ---
title: "extrude" title: "extrude"
excerpt: "Extend a 2-dimensional sketch through a third dimension in order to" 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 layout: manual
--- ---
Extend a 2-dimensional sketch through a third dimension in order to 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.
create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.
```js ```js
extrude( extrude(
sketchSet: SketchSet, sketchSet: SketchSet,
length: number, length: number,
) -> SolidSet ): SolidSet
``` ```

View File

@ -15,7 +15,7 @@ fillet(
tags: [EdgeReference], tags: [EdgeReference],
tolerance?: number, tolerance?: number,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Solid ): Solid
``` ```

View File

@ -9,7 +9,7 @@ Compute the largest integer less than or equal to a number.
```js ```js
floor(num: number) -> number floor(num: number): number
``` ```
### Tags ### Tags

View File

@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `12`.
We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters. We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters.
```js ```js
ft() -> number ft(): number
``` ```
### Tags ### Tags

View File

@ -9,7 +9,7 @@ Get the next adjacent edge to the edge given.
```js ```js
getNextAdjacentEdge(tag: TagIdentifier) -> Uuid getNextAdjacentEdge(tag: TagIdentifier): Uuid
``` ```

View File

@ -9,7 +9,7 @@ Get the opposite edge to the edge given.
```js ```js
getOppositeEdge(tag: TagIdentifier) -> Uuid getOppositeEdge(tag: TagIdentifier): Uuid
``` ```

View File

@ -9,7 +9,7 @@ Get the previous adjacent edge to the edge given.
```js ```js
getPreviousAdjacentEdge(tag: TagIdentifier) -> Uuid getPreviousAdjacentEdge(tag: TagIdentifier): Uuid
``` ```

View File

@ -16,7 +16,7 @@ helix(
radius: number, radius: number,
axis: Axis3dOrEdgeReference, axis: Axis3dOrEdgeReference,
length?: number, length?: number,
) -> HelixValue ): HelixValue
``` ```

View File

@ -12,7 +12,7 @@ Create a helix on a cylinder.
helixRevolutions( helixRevolutions(
data: HelixRevolutionsData, data: HelixRevolutionsData,
solid: Solid, solid: Solid,
) -> Solid ): Solid
``` ```

View File

@ -12,7 +12,7 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.
hole( hole(
holeSketch: SketchSet, holeSketch: SketchSet,
sketch: Sketch, sketch: Sketch,
) -> Sketch ): Sketch
``` ```

View File

@ -12,7 +12,7 @@ Remove volume from a 3-dimensional shape such that a wall of the provided thickn
hollow( hollow(
thickness: number, thickness: number,
solid: Solid, solid: Solid,
) -> Solid ): Solid
``` ```

View File

@ -18,7 +18,7 @@ Note: The import command currently only works when using the native Modeling App
import( import(
filePath: String, filePath: String,
options?: ImportFormat, options?: ImportFormat,
) -> ImportedGeometry ): ImportedGeometry
``` ```

View File

@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `1`.
We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters. We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters.
```js ```js
inch() -> number inch(): number
``` ```
### Tags ### Tags

View File

@ -11,7 +11,7 @@ Convert a number to an integer.
DEPRECATED use floor(), ceil(), or round(). DEPRECATED use floor(), ceil(), or round().
```js ```js
int(num: number) -> number int(num: number): number
``` ```
### Tags ### Tags

View File

@ -1,15 +1,15 @@
--- ---
title: "lastSegX" title: "lastSegX"
excerpt: "Extract the 'x' axis value of the last line segment in the provided 2-d" excerpt: "Extract the 'x' axis value of the last line segment in the provided 2-d sketch."
layout: manual layout: manual
--- ---
Extract the 'x' axis value of the last line segment in the provided 2-d Extract the 'x' axis value of the last line segment in the provided 2-d sketch.
sketch.
```js ```js
lastSegX(sketch: Sketch) -> number lastSegX(sketch: Sketch): number
``` ```

View File

@ -1,15 +1,15 @@
--- ---
title: "lastSegY" title: "lastSegY"
excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-d" excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-d sketch."
layout: manual layout: manual
--- ---
Extract the 'y' axis value of the last line segment in the provided 2-d Extract the 'y' axis value of the last line segment in the provided 2-d sketch.
sketch.
```js ```js
lastSegY(sketch: Sketch) -> number lastSegY(sketch: Sketch): number
``` ```

View File

@ -12,7 +12,7 @@ Compute the angle of the given leg for x.
legAngX( legAngX(
hypotenuse: number, hypotenuse: number,
leg: number, leg: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -12,7 +12,7 @@ Compute the angle of the given leg for y.
legAngY( legAngY(
hypotenuse: number, hypotenuse: number,
leg: number, leg: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -12,7 +12,7 @@ Compute the length of the given leg.
legLen( legLen(
hypotenuse: number, hypotenuse: number,
leg: number, leg: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -14,7 +14,7 @@ line(
endAbsolute?: [number], endAbsolute?: [number],
end?: [number], end?: [number],
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -9,7 +9,7 @@ Compute the natural logarithm of the number.
```js ```js
ln(num: number) -> number ln(num: number): number
``` ```
### Tags ### Tags

View File

@ -15,7 +15,7 @@ loft(
bezApproximateRational: bool, bezApproximateRational: bool,
baseCurveIndex?: integer, baseCurveIndex?: integer,
tolerance?: number, tolerance?: number,
) -> Solid ): Solid
``` ```

View File

@ -12,7 +12,7 @@ The result might not be correctly rounded owing to implementation details; `log2
log( log(
num: number, num: number,
base: number, base: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -9,7 +9,7 @@ Compute the base 10 logarithm of the number.
```js ```js
log10(num: number) -> number log10(num: number): number
``` ```
### Tags ### Tags

View File

@ -9,7 +9,7 @@ Compute the base 2 logarithm of the number.
```js ```js
log2(num: number) -> number log2(num: number): number
``` ```
### Tags ### Tags

View File

@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `39.3
We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters. We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters.
```js ```js
m() -> number m(): number
``` ```
### Tags ### Tags

View File

@ -12,7 +12,7 @@ Given a list like `[a, b, c]`, and a function like `f`, returns `[f(a), f(b), f(
map( map(
array: [KclValue], array: [KclValue],
mapFn: FunctionSource, mapFn: FunctionSource,
) -> [KclValue] ): [KclValue]
``` ```

View File

@ -9,7 +9,7 @@ Compute the maximum of the given arguments.
```js ```js
max(args: [number]) -> number max(args: [number]): number
``` ```
### Tags ### Tags

View File

@ -9,7 +9,7 @@ Compute the minimum of the given arguments.
```js ```js
min(args: [number]) -> number min(args: [number]): number
``` ```
### Tags ### Tags

View File

@ -14,7 +14,7 @@ Mirror occurs around a local sketch axis rather than a global axis.
mirror2d( mirror2d(
data: Mirror2dData, data: Mirror2dData,
sketchSet: SketchSet, sketchSet: SketchSet,
) -> [Sketch] ): [Sketch]
``` ```

View File

@ -15,7 +15,7 @@ For example, if the current project uses inches, this function will return `(1/2
We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches. We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches.
```js ```js
mm() -> number mm(): number
``` ```
### Tags ### Tags

View File

@ -12,7 +12,7 @@ For example, if you offset the 'XZ' plane by 10, the new plane will be parallel
offsetPlane( offsetPlane(
plane: PlaneData, plane: PlaneData,
offset: number, offset: number,
) -> Plane ): Plane
``` ```

View File

@ -1,12 +1,12 @@
--- ---
title: "patternCircular2d" title: "patternCircular2d"
excerpt: "Repeat a 2-dimensional sketch some number of times along a partial or" 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 orentation of the solid with respect to the center of the circle is maintained."
layout: manual layout: manual
--- ---
Repeat a 2-dimensional sketch some number of times along a partial or 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 orentation of the solid with respect to the center of the circle is maintained.
complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
```js ```js
patternCircular2d( patternCircular2d(
@ -16,7 +16,7 @@ patternCircular2d(
arcDegrees: number, arcDegrees: number,
rotateDuplicates: bool, rotateDuplicates: bool,
useOriginal?: bool, useOriginal?: bool,
) -> [Sketch] ): [Sketch]
``` ```

View File

@ -1,12 +1,12 @@
--- ---
title: "patternCircular3d" title: "patternCircular3d"
excerpt: "Repeat a 3-dimensional solid some number of times along a partial or" 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 orentation of the solid with respect to the center of the circle is maintained."
layout: manual layout: manual
--- ---
Repeat a 3-dimensional solid some number of times along a partial or 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 orentation of the solid with respect to the center of the circle is maintained.
complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.
```js ```js
patternCircular3d( patternCircular3d(
@ -17,7 +17,7 @@ patternCircular3d(
arcDegrees: number, arcDegrees: number,
rotateDuplicates: bool, rotateDuplicates: bool,
useOriginal?: bool, useOriginal?: bool,
) -> [Solid] ): [Solid]
``` ```

View File

@ -1,12 +1,12 @@
--- ---
title: "patternLinear2d" title: "patternLinear2d"
excerpt: "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount" 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 layout: manual
--- ---
Repeat a 2-dimensional sketch along some dimension, with a dynamic amount Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times.
of distance between each repetition, some specified number of times.
```js ```js
patternLinear2d( patternLinear2d(
@ -15,7 +15,7 @@ patternLinear2d(
distance: number, distance: number,
axis: [number], axis: [number],
useOriginal?: bool, useOriginal?: bool,
) -> [Sketch] ): [Sketch]
``` ```

View File

@ -1,12 +1,10 @@
--- ---
title: "patternLinear3d" title: "patternLinear3d"
excerpt: "Repeat a 3-dimensional solid along a linear path, with a dynamic amount" 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 layout: manual
--- ---
Repeat a 3-dimensional solid along a linear path, with a dynamic amount Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times.
of distance between each repetition, some specified number of times.
/// ///
@ -17,7 +15,7 @@ patternLinear3d(
distance: number, distance: number,
axis: [number], axis: [number],
useOriginal?: bool, useOriginal?: bool,
) -> [Solid] ): [Solid]
``` ```

View File

@ -40,7 +40,7 @@ patternTransform(
instances: integer, instances: integer,
transform: FunctionSource, transform: FunctionSource,
useOriginal?: bool, useOriginal?: bool,
) -> [Solid] ): [Solid]
``` ```

View File

@ -14,7 +14,7 @@ patternTransform2d(
instances: integer, instances: integer,
transform: FunctionSource, transform: FunctionSource,
useOriginal?: bool, useOriginal?: bool,
) -> [Sketch] ): [Sketch]
``` ```

View File

@ -11,7 +11,7 @@ Return the value of `pi`. Archimedes constant (π).
**DEPRECATED** use the constant PI **DEPRECATED** use the constant PI
```js ```js
pi() -> number pi(): number
``` ```
### Tags ### Tags

View File

@ -1,15 +1,15 @@
--- ---
title: "polar" title: "polar"
excerpt: "Convert polar/sphere (azimuth, elevation, distance) coordinates to" excerpt: "Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates."
layout: manual layout: manual
--- ---
Convert polar/sphere (azimuth, elevation, distance) coordinates to Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates.
cartesian (x/y/z grid) coordinates.
```js ```js
polar(data: PolarCoordsData) -> [number] polar(data: PolarCoordsData): [number]
``` ```

View File

@ -13,7 +13,7 @@ polygon(
data: PolygonData, data: PolygonData,
sketchSurfaceOrGroup: SketchOrSurface, sketchSurfaceOrGroup: SketchOrSurface,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -9,7 +9,7 @@ Remove the last element from an array.
Returns a new array with the last element removed. Returns a new array with the last element removed.
```js ```js
pop(array: [KclValue]) -> KclValue pop(array: [KclValue]): KclValue
``` ```

View File

@ -12,7 +12,7 @@ Compute the number to a power.
pow( pow(
num: number, num: number,
pow: number, pow: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -1,15 +1,15 @@
--- ---
title: "profileStart" title: "profileStart"
excerpt: "Extract the provided 2-dimensional sketch's profile's origin" excerpt: "Extract the provided 2-dimensional sketch's profile's origin value."
layout: manual layout: manual
--- ---
Extract the provided 2-dimensional sketch's profile's origin Extract the provided 2-dimensional sketch's profile's origin value.
value.
```js ```js
profileStart(sketch: Sketch) -> [number] profileStart(sketch: Sketch): [number]
``` ```

View File

@ -1,15 +1,15 @@
--- ---
title: "profileStartX" title: "profileStartX"
excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'x'" excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'x' value."
layout: manual layout: manual
--- ---
Extract the provided 2-dimensional sketch's profile's origin's 'x' Extract the provided 2-dimensional sketch's profile's origin's 'x' value.
value.
```js ```js
profileStartX(sketch: Sketch) -> number profileStartX(sketch: Sketch): number
``` ```

View File

@ -1,15 +1,15 @@
--- ---
title: "profileStartY" title: "profileStartY"
excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y'" excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y' value."
layout: manual layout: manual
--- ---
Extract the provided 2-dimensional sketch's profile's origin's 'y' Extract the provided 2-dimensional sketch's profile's origin's 'y' value.
value.
```js ```js
profileStartY(sketch: Sketch) -> number profileStartY(sketch: Sketch): number
``` ```

View File

@ -12,7 +12,7 @@ Returns a new array with the element appended.
push( push(
array: [KclValue], array: [KclValue],
elem: KclValue, elem: KclValue,
) -> KclValue ): KclValue
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "reduce" title: "reduce"
excerpt: "Take a starting value. Then, for each element of an array, calculate the next value," 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 layout: manual
--- ---
Take a starting value. Then, for each element of an array, calculate the next value, Take a starting value. Then, for each element of an array, calculate the next value, using the previous value and the element.
using the previous value and the element.
```js ```js
reduce( reduce(
array: [KclValue], array: [KclValue],
start: KclValue, start: KclValue,
reduceFn: FunctionSource, reduceFn: FunctionSource,
) -> KclValue ): KclValue
``` ```

View File

@ -1,18 +1,18 @@
--- ---
title: "rem" title: "rem"
excerpt: "Compute the remainder after dividing `num` by `div`." excerpt: "Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too."
layout: manual layout: manual
--- ---
Compute the remainder after dividing `num` by `div`. Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too.
If `num` is negative, the result will be too.
```js ```js
rem( rem(
num: number, num: number,
divisor: number, divisor: number,
) -> number ): number
``` ```
### Tags ### Tags

View File

@ -14,7 +14,7 @@ Revolve occurs around a local sketch axis rather than a global axis.
revolve( revolve(
data: RevolveData, data: RevolveData,
sketch: Sketch, sketch: Sketch,
) -> Solid ): Solid
``` ```

View File

@ -31,7 +31,7 @@ rotate(
axis?: [number], axis?: [number],
angle?: number, angle?: number,
global?: bool, global?: bool,
) -> Solid ): Solid
``` ```

View File

@ -9,7 +9,7 @@ Round a number to the nearest integer.
```js ```js
round(num: number) -> number round(num: number): number
``` ```
### Tags ### Tags

View File

@ -15,7 +15,7 @@ scale(
solid: Solid, solid: Solid,
scale: [number], scale: [number],
global?: bool, global?: bool,
) -> Solid ): Solid
``` ```

View File

@ -9,7 +9,7 @@ Compute the angle (in degrees) of the provided line segment.
```js ```js
segAng(tag: TagIdentifier) -> number segAng(tag: TagIdentifier): number
``` ```

View File

@ -9,7 +9,7 @@ Compute the ending point of the provided line segment.
```js ```js
segEnd(tag: TagIdentifier) -> [number] segEnd(tag: TagIdentifier): [number]
``` ```

View File

@ -9,7 +9,7 @@ Compute the ending point of the provided line segment along the 'x' axis.
```js ```js
segEndX(tag: TagIdentifier) -> number segEndX(tag: TagIdentifier): number
``` ```

View File

@ -9,7 +9,7 @@ Compute the ending point of the provided line segment along the 'y' axis.
```js ```js
segEndY(tag: TagIdentifier) -> number segEndY(tag: TagIdentifier): number
``` ```

View File

@ -9,7 +9,7 @@ Compute the length of the provided line segment.
```js ```js
segLen(tag: TagIdentifier) -> number segLen(tag: TagIdentifier): number
``` ```

View File

@ -9,7 +9,7 @@ Compute the starting point of the provided line segment.
```js ```js
segStart(tag: TagIdentifier) -> [number] segStart(tag: TagIdentifier): [number]
``` ```

View File

@ -9,7 +9,7 @@ Compute the starting point of the provided line segment along the 'x' axis.
```js ```js
segStartX(tag: TagIdentifier) -> number segStartX(tag: TagIdentifier): number
``` ```

View File

@ -9,7 +9,7 @@ Compute the starting point of the provided line segment along the 'y' axis.
```js ```js
segStartY(tag: TagIdentifier) -> number segStartY(tag: TagIdentifier): number
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "shell" title: "shell"
excerpt: "Remove volume from a 3-dimensional shape such that a wall of the" 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 layout: manual
--- ---
Remove volume from a 3-dimensional shape such that a wall of the 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.
provided thickness remains, taking volume starting at the provided face, leaving it open in that direction.
```js ```js
shell( shell(
solidSet: SolidSet, solidSet: SolidSet,
thickness: number, thickness: number,
faces: [FaceTag], faces: [FaceTag],
) -> SolidSet ): SolidSet
``` ```

View File

@ -9,7 +9,7 @@ Compute the square root of a number.
```js ```js
sqrt(num: number) -> number sqrt(num: number): number
``` ```
### Tags ### Tags

View File

@ -13,7 +13,7 @@ startProfileAt(
to: [number], to: [number],
sketchSurface: SketchSurface, sketchSurface: SketchSurface,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -20,7 +20,7 @@ The point is if you want to export the result of a sketch on a face, you only ne
startSketchOn( startSketchOn(
data: SketchData, data: SketchData,
tag?: FaceTag, tag?: FaceTag,
) -> SketchSurface ): SketchSurface
``` ```

View File

@ -7827,8 +7827,8 @@
}, },
{ {
"name": "angledLine", "name": "angledLine",
"summary": "Draw a line segment relative to the current origin using the polar", "summary": "Draw a line segment relative to the current origin using the polar measure of some angle and distance.",
"description": "measure of some angle and distance.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -12847,8 +12847,8 @@
}, },
{ {
"name": "angledLineOfXLength", "name": "angledLineOfXLength",
"summary": "Create a line segment from the current 2-dimensional sketch origin", "summary": "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'x' dimension.",
"description": "along some angle (in degrees) for some relative length in the 'x' dimension.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -17867,8 +17867,8 @@
}, },
{ {
"name": "angledLineOfYLength", "name": "angledLineOfYLength",
"summary": "Create a line segment from the current 2-dimensional sketch origin", "summary": "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some relative length in the 'y' dimension.",
"description": "along some angle (in degrees) for some relative length in the 'y' dimension.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -22887,8 +22887,8 @@
}, },
{ {
"name": "angledLineThatIntersects", "name": "angledLineThatIntersects",
"summary": "Draw an angled line from the current origin, constructing a line segment", "summary": "Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment.",
"description": "such that the newly created line intersects the desired target line segment.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -28987,8 +28987,8 @@
}, },
{ {
"name": "angledLineToX", "name": "angledLineToX",
"summary": "Create a line segment from the current 2-dimensional sketch origin", "summary": "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.",
"description": "along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -33992,8 +33992,8 @@
}, },
{ {
"name": "angledLineToY", "name": "angledLineToY",
"summary": "Create a line segment from the current 2-dimensional sketch origin", "summary": "Create a line segment from the current 2-dimensional sketch origin along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.",
"description": "along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -52323,7 +52323,7 @@
}, },
{ {
"name": "arcTo", "name": "arcTo",
"summary": "Draw a 3 point arc.", "summary": "Draw a three point arc.",
"description": "The arc is constructed such that the start point is the current position of the sketch and two more points defined as the end and interior point. The interior point is placed between the start point and end point. The radius of the arc will be controlled by how far the interior point is placed from the start and end.", "description": "The arc is constructed such that the start point is the current position of the sketch and two more points defined as the end and interior point. The interior point is placed between the start point and end point. The radius of the arc will be controlled by how far the interior point is placed from the start and end.",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
@ -57380,8 +57380,8 @@
}, },
{ {
"name": "assert", "name": "assert",
"summary": "Check a value at runtime, and raise an error if the argument provided", "summary": "Check a value at runtime, and raise an error if the argument provided is false.",
"description": "is false.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -57430,8 +57430,8 @@
}, },
{ {
"name": "assertEqual", "name": "assertEqual",
"summary": "Check that a numerical value equals another at runtime,", "summary": "Check that a numerical value equals another at runtime, otherwise raise an error.",
"description": "otherwise raise an error.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -57507,8 +57507,8 @@
}, },
{ {
"name": "assertGreaterThan", "name": "assertGreaterThan",
"summary": "Check that a numerical value is greater than another at runtime,", "summary": "Check that a numerical value is greater than another at runtime, otherwise raise an error.",
"description": "otherwise raise an error.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -57571,8 +57571,8 @@
}, },
{ {
"name": "assertGreaterThanOrEq", "name": "assertGreaterThanOrEq",
"summary": "Check that a numerical value is greater than or equal to another at runtime,", "summary": "Check that a numerical value is greater than or equal to another at runtime, otherwise raise an error.",
"description": "otherwise raise an error.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -57635,8 +57635,8 @@
}, },
{ {
"name": "assertLessThan", "name": "assertLessThan",
"summary": "Check that a numerical value is less than to another at runtime,", "summary": "Check that a numerical value is less than to another at runtime, otherwise raise an error.",
"description": "otherwise raise an error.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -57699,8 +57699,8 @@
}, },
{ {
"name": "assertLessThanOrEq", "name": "assertLessThanOrEq",
"summary": "Check that a numerical value is less than or equal to another at runtime,", "summary": "Check that a numerical value is less than or equal to another at runtime, otherwise raise an error.",
"description": "otherwise raise an error.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -57860,8 +57860,8 @@
}, },
{ {
"name": "bezierCurve", "name": "bezierCurve",
"summary": "Draw a smooth, continuous, curved line segment from the current origin to", "summary": "Draw a smooth, continuous, curved line segment from the current origin to the desired (x, y), using a number of control points to shape the curve's shape.",
"description": "the desired (x, y), using a number of control points to shape the curve's shape.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -71169,8 +71169,8 @@
}, },
{ {
"name": "circle", "name": "circle",
"summary": "Construct a 2-dimensional circle, of the specified radius, centered at", "summary": "Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point.",
"description": "the provided (x, y) origin point.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -84280,8 +84280,8 @@
}, },
{ {
"name": "close", "name": "close",
"summary": "Construct a line segment from the current origin back to the profile's", "summary": "Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended.",
"description": "origin, ensuring the resulting 2-dimensional sketch is not open-ended.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -89315,8 +89315,8 @@
}, },
{ {
"name": "extrude", "name": "extrude",
"summary": "Extend a 2-dimensional sketch through a third dimension in order to", "summary": "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.",
"description": "create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -122706,8 +122706,8 @@
}, },
{ {
"name": "lastSegX", "name": "lastSegX",
"summary": "Extract the 'x' axis value of the last line segment in the provided 2-d", "summary": "Extract the 'x' axis value of the last line segment in the provided 2-d sketch.",
"description": "sketch.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -124410,8 +124410,8 @@
}, },
{ {
"name": "lastSegY", "name": "lastSegY",
"summary": "Extract the 'y' axis value of the last line segment in the provided 2-d", "summary": "Extract the 'y' axis value of the last line segment in the provided 2-d sketch.",
"description": "sketch.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -157467,8 +157467,8 @@
}, },
{ {
"name": "patternCircular2d", "name": "patternCircular2d",
"summary": "Repeat a 2-dimensional sketch some number of times along a partial or", "summary": "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 orentation of the solid with respect to the center of the circle is maintained.",
"description": "complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -168843,8 +168843,8 @@
}, },
{ {
"name": "patternCircular3d", "name": "patternCircular3d",
"summary": "Repeat a 3-dimensional solid some number of times along a partial or", "summary": "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 orentation of the solid with respect to the center of the circle is maintained.",
"description": "complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orentation of the solid with respect to the center of the circle is maintained.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -181836,8 +181836,8 @@
}, },
{ {
"name": "patternLinear2d", "name": "patternLinear2d",
"summary": "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount", "summary": "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times.",
"description": "of distance between each repetition, some specified number of times.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -191605,8 +191605,8 @@
}, },
{ {
"name": "patternLinear3d", "name": "patternLinear3d",
"summary": "Repeat a 3-dimensional solid along a linear path, with a dynamic amount", "summary": "Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times.",
"description": "of distance between each repetition, some specified number of times.\n\n///", "description": "///",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -217727,8 +217727,8 @@
}, },
{ {
"name": "polar", "name": "polar",
"summary": "Convert polar/sphere (azimuth, elevation, distance) coordinates to", "summary": "Convert polar/sphere (azimuth, elevation, distance) coordinates to cartesian (x/y/z grid) coordinates.",
"description": "cartesian (x/y/z grid) coordinates.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -228885,8 +228885,8 @@
}, },
{ {
"name": "profileStart", "name": "profileStart",
"summary": "Extract the provided 2-dimensional sketch's profile's origin", "summary": "Extract the provided 2-dimensional sketch's profile's origin value.",
"description": "value.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -230593,8 +230593,8 @@
}, },
{ {
"name": "profileStartX", "name": "profileStartX",
"summary": "Extract the provided 2-dimensional sketch's profile's origin's 'x'", "summary": "Extract the provided 2-dimensional sketch's profile's origin's 'x' value.",
"description": "value.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -232296,8 +232296,8 @@
}, },
{ {
"name": "profileStartY", "name": "profileStartY",
"summary": "Extract the provided 2-dimensional sketch's profile's origin's 'y'", "summary": "Extract the provided 2-dimensional sketch's profile's origin's 'y' value.",
"description": "value.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -242801,8 +242801,8 @@
}, },
{ {
"name": "reduce", "name": "reduce",
"summary": "Take a starting value. Then, for each element of an array, calculate the next value,", "summary": "Take a starting value. Then, for each element of an array, calculate the next value, using the previous value and the element.",
"description": "using the previous value and the element.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -254200,8 +254200,8 @@
}, },
{ {
"name": "rem", "name": "rem",
"summary": "Compute the remainder after dividing `num` by `div`.", "summary": "Compute the remainder after dividing `num` by `div`. If `num` is negative, the result will be too.",
"description": "If `num` is negative, the result will be too.", "description": "",
"tags": [ "tags": [
"math" "math"
], ],
@ -287644,8 +287644,8 @@
}, },
{ {
"name": "shell", "name": "shell",
"summary": "Remove volume from a 3-dimensional shape such that a wall of the", "summary": "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.",
"description": "provided thickness remains, taking volume starting at the provided face, leaving it open in that direction.", "description": "",
"tags": [], "tags": [],
"keywordArguments": true, "keywordArguments": true,
"args": [ "args": [
@ -319362,8 +319362,8 @@
}, },
{ {
"name": "tangentialArcTo", "name": "tangentialArcTo",
"summary": "Starting at the current sketch's origin, draw a curved line segment along", "summary": "Starting at the current sketch's origin, draw a curved line segment along some part of an imaginary circle until it reaches the desired (x, y) coordinates.",
"description": "some part of an imaginary circle until it reaches the desired (x, y) coordinates.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -324356,8 +324356,8 @@
}, },
{ {
"name": "tangentialArcToRelative", "name": "tangentialArcToRelative",
"summary": "Starting at the current sketch's origin, draw a curved line segment along", "summary": "Starting at the current sketch's origin, draw a curved line segment along some part of an imaginary circle until it reaches a point the given (x, y) distance away.",
"description": "some part of an imaginary circle until it reaches a point the given (x, y) distance away.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -336057,8 +336057,8 @@
}, },
{ {
"name": "xLine", "name": "xLine",
"summary": "Draw a line relative to the current origin to a specified distance away", "summary": "Draw a line relative to the current origin to a specified distance away from the current position along the 'x' axis.",
"description": "from the current position along the 'x' axis.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -341046,8 +341046,8 @@
}, },
{ {
"name": "xLineTo", "name": "xLineTo",
"summary": "Draw a line parallel to the X axis, that ends at the given X.", "summary": "Draw a line parallel to the X axis, that ends at the given X. E.g. if the previous line ended at (1, 1), then xLineTo(4) draws a line from (1, 1) to (4, 1)",
"description": "E.g. if the previous line ended at (1, 1), then xLineTo(4) draws a line from (1, 1) to (4, 1)", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -346035,8 +346035,8 @@
}, },
{ {
"name": "yLine", "name": "yLine",
"summary": "Draw a line relative to the current origin to a specified distance away", "summary": "Draw a line relative to the current origin to a specified distance away from the current position along the 'y' axis.",
"description": "from the current position along the 'y' axis.", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [
@ -351024,8 +351024,8 @@
}, },
{ {
"name": "yLineTo", "name": "yLineTo",
"summary": "Draw a line parallel to the Y axis, that ends at the given Y.", "summary": "Draw a line parallel to the Y axis, that ends at the given Y. E.g. if the previous line ended at (1, 1), then yLineTo(4) draws a line from (1, 1) to (1, 4)",
"description": "E.g. if the previous line ended at (1, 1), then yLineTo(4) draws a line from (1, 1) to (1, 4)", "description": "",
"tags": [], "tags": [],
"keywordArguments": false, "keywordArguments": false,
"args": [ "args": [

View File

@ -14,7 +14,7 @@ sweep(
path: SweepPath, path: SweepPath,
sectional?: bool, sectional?: bool,
tolerance?: number, tolerance?: number,
) -> Solid ): Solid
``` ```

View File

@ -9,7 +9,7 @@ Returns the angle coming out of the end of the segment in degrees.
```js ```js
tangentToEnd(tag: TagIdentifier) -> number tangentToEnd(tag: TagIdentifier): number
``` ```

View File

@ -13,7 +13,7 @@ tangentialArc(
data: TangentialArcData, data: TangentialArcData,
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

View File

@ -1,19 +1,19 @@
--- ---
title: "tangentialArcTo" title: "tangentialArcTo"
excerpt: "Starting at the current sketch's origin, draw a curved line segment along" excerpt: "Starting at the current sketch's origin, draw a curved line segment along some part of an imaginary circle until it reaches the desired (x, y) coordinates."
layout: manual layout: manual
--- ---
Starting at the current sketch's origin, draw a curved line segment along Starting at the current sketch's origin, draw a curved line segment along some part of an imaginary circle until it reaches the desired (x, y) coordinates.
some part of an imaginary circle until it reaches the desired (x, y) coordinates.
```js ```js
tangentialArcTo( tangentialArcTo(
to: [number], to: [number],
sketch: Sketch, sketch: Sketch,
tag?: TagDeclarator, tag?: TagDeclarator,
) -> Sketch ): Sketch
``` ```

Some files were not shown because too many files have changed in this diff Show More