2023-08-25 13:41:04 -07:00
<!-- - DO NOT EDIT THIS FILE. IT IS AUTOMATICALLY GENERATED. -->
# KCL Standard Library
## Table of Contents
* [Functions ](#functions )
2023-09-15 15:54:49 -07:00
* [`abs` ](#abs )
* [`acos` ](#acos )
2023-08-25 13:41:04 -07:00
* [`angleToMatchLengthX` ](#angleToMatchLengthX )
* [`angleToMatchLengthY` ](#angleToMatchLengthY )
* [`angledLine` ](#angledLine )
* [`angledLineOfXLength` ](#angledLineOfXLength )
* [`angledLineOfYLength` ](#angledLineOfYLength )
* [`angledLineThatIntersects` ](#angledLineThatIntersects )
2023-09-05 16:02:27 -07:00
* [`angledLineToX` ](#angledLineToX )
* [`angledLineToY` ](#angledLineToY )
2023-08-31 22:19:23 -07:00
* [`arc` ](#arc )
2023-09-15 15:54:49 -07:00
* [`asin` ](#asin )
* [`atan` ](#atan )
2023-08-31 22:19:23 -07:00
* [`bezierCurve` ](#bezierCurve )
2023-09-15 15:54:49 -07:00
* [`ceil` ](#ceil )
2023-09-05 16:02:27 -07:00
* [`close` ](#close )
2023-09-13 15:09:07 -07:00
* [`cos` ](#cos )
2023-09-15 17:40:57 -07:00
* [`e` ](#e )
2023-09-05 16:02:27 -07:00
* [`extrude` ](#extrude )
2023-09-15 15:54:49 -07:00
* [`floor` ](#floor )
2023-09-05 16:02:27 -07:00
* [`getExtrudeWallTransform` ](#getExtrudeWallTransform )
2023-10-13 12:02:46 -07:00
* [`hole` ](#hole )
2023-09-05 16:02:27 -07:00
* [`lastSegX` ](#lastSegX )
* [`lastSegY` ](#lastSegY )
* [`legAngX` ](#legAngX )
* [`legAngY` ](#legAngY )
* [`legLen` ](#legLen )
* [`line` ](#line )
* [`lineTo` ](#lineTo )
2023-09-15 17:40:57 -07:00
* [`ln` ](#ln )
* [`log` ](#log )
* [`log10` ](#log10 )
* [`log2` ](#log2 )
2023-09-15 15:54:49 -07:00
* [`max` ](#max )
2023-09-05 16:02:27 -07:00
* [`min` ](#min )
2023-09-13 15:09:07 -07:00
* [`pi` ](#pi )
2023-09-15 15:54:49 -07:00
* [`pow` ](#pow )
2023-09-05 16:02:27 -07:00
* [`segAng` ](#segAng )
* [`segEndX` ](#segEndX )
* [`segEndY` ](#segEndY )
* [`segLen` ](#segLen )
* [`show` ](#show )
2023-09-13 15:09:07 -07:00
* [`sin` ](#sin )
2023-09-15 15:54:49 -07:00
* [`sqrt` ](#sqrt )
2023-10-05 14:27:48 -07:00
* [`startProfileAt` ](#startProfileAt )
2023-09-05 16:02:27 -07:00
* [`startSketchAt` ](#startSketchAt )
2023-10-05 14:27:48 -07:00
* [`startSketchOn` ](#startSketchOn )
2023-09-13 15:09:07 -07:00
* [`tan` ](#tan )
2023-10-12 11:50:54 -05:00
* [`tangentialArc` ](#tangentialArc )
* [`tangentialArcTo` ](#tangentialArcTo )
2023-09-15 17:40:57 -07:00
* [`tau` ](#tau )
2023-09-05 16:02:27 -07:00
* [`xLine` ](#xLine )
* [`xLineTo` ](#xLineTo )
* [`yLine` ](#yLine )
* [`yLineTo` ](#yLineTo )
2023-08-25 13:41:04 -07:00
## Functions
2023-09-15 15:54:49 -07:00
### abs
Computes the absolute value of a number.
```
abs(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
### acos
Computes the arccosine of a number (in radians).
```
acos(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### angleToMatchLengthX
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Returns the angle to match the given length for x.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> number
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `segment_name` : `string`
* `to` : `number`
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
{
// The id of the sketch group.
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-09-05 16:02:27 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-05 16:02:27 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
}],
}
2023-08-25 13:41:04 -07:00
```
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### angleToMatchLengthY
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Returns the angle to match the given length for y.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> number
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `segment_name` : `string`
* `to` : `number`
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `number`
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
### angledLine
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an angled line.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angledLine(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AngledLineData` - Data to draw an angled line.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The angle of the line.
angle: number,
// The length of the line.
length: number,
// The tag.
tag: string,
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### angledLineOfXLength
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an angled line of a given x length.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AngledLineData` - Data to draw an angled line.
```
{
// The angle of the line.
angle: number,
// The length of the line.
length: number,
// The tag.
tag: string,
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-09-05 16:02:27 -07:00
```
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### angledLineOfYLength
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an angled line of a given y length.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AngledLineData` - Data to draw an angled line.
```
{
// The angle of the line.
angle: number,
// The length of the line.
length: number,
// The tag.
tag: string,
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-09-05 16:02:27 -07:00
```
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### angledLineThatIntersects
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an angled line that intersects with a given line.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angledLineThatIntersects(data: AngeledLineThatIntersectsData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AngeledLineThatIntersectsData` - Data for drawing an angled line that intersects with a given line.
```
{
// The angle of the line.
angle: number,
// The tag of the line to intersect with.
intersectTag: string,
// The offset from the intersecting line.
offset: number,
// The tag.
tag: string,
}
```
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### angledLineToX
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an angled line to a given x coordinate.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angledLineToX(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AngledLineToData` - Data to draw an angled line to a point.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The angle of the line.
angle: number,
2023-08-25 13:41:04 -07:00
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
// The point to draw to.
to: number,
2023-08-25 13:41:04 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### angledLineToY
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an angled line to a given y coordinate.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
angledLineToY(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AngledLineToData` - Data to draw an angled line to a point.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The angle of the line.
angle: number,
2023-08-25 13:41:04 -07:00
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
// The point to draw to.
to: number,
2023-08-25 13:41:04 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### arc
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw an arc.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
arc(data: ArcData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `ArcData` - Data to draw an arc.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The end angle.
angle_end: number,
// The start angle.
angle_start: number,
// The radius.
radius: number,
// The tag.
tag: string,
} |
{
// The end angle.
angle_end: number,
// The start angle.
angle_start: number,
// The radius.
radius: number,
} |
{
// The center.
2023-10-11 13:12:21 -05:00
center: [number, number],
2023-09-05 16:02:27 -07:00
// The radius.
radius: number,
2023-08-25 13:41:04 -07:00
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
} |
2023-09-05 16:02:27 -07:00
{
// The center.
2023-10-11 13:12:21 -05:00
center: [number, number],
2023-09-05 16:02:27 -07:00
// The radius.
radius: number,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
}
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-15 15:54:49 -07:00
### asin
Computes the arcsine of a number (in radians).
```
asin(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
### atan
Computes the arctangent of a number (in radians).
```
atan(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### bezierCurve
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw a bezier curve.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
bezierCurve(data: BezierData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `BezierData` - Data to draw a bezier curve.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The first control point.
2023-10-11 13:12:21 -05:00
control1: [number, number],
2023-09-05 16:02:27 -07:00
// The second control point.
2023-10-11 13:12:21 -05:00
control2: [number, number],
2023-08-25 13:41:04 -07:00
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
} |
2023-09-05 16:02:27 -07:00
{
// The first control point.
2023-10-11 13:12:21 -05:00
control1: [number, number],
2023-09-05 16:02:27 -07:00
// The second control point.
2023-10-11 13:12:21 -05:00
control2: [number, number],
2023-09-05 16:02:27 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
}
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-15 15:54:49 -07:00
### ceil
Computes the smallest integer greater than or equal to a number.
```
ceil(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### close
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Close the current sketch.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
close(sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-13 15:09:07 -07:00
### cos
Computes the sine of a number (in radians).
```
cos(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-09-15 17:40:57 -07:00
### e
Return the value of Euler’ s number `e` .
```
e() -> number
```
#### Arguments
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### extrude
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Extrudes by a given amount.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
extrude(length: number, sketch_group: SketchGroup) -> ExtrudeGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `length` : `number`
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `ExtrudeGroup` - An extrude group is a collection of extrude surfaces.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The height of the extrude group.
height: number,
// The id of the extrude group.
id: uuid,
// The position of the extrude group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-05 16:02:27 -07:00
// The rotation of the extrude group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
// The extrude surfaces.
value: [{
// The id of the geometry.
id: uuid,
// The name.
name: string,
// The position.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-05 16:02:27 -07:00
// The rotation.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
// The source range.
2023-10-11 13:12:21 -05:00
sourceRange: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-15 15:54:49 -07:00
### floor
Computes the largest integer less than or equal to a number.
```
floor(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### getExtrudeWallTransform
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Returns the extrude wall transform.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
getExtrudeWallTransform(surface_name: string, extrude_group: ExtrudeGroup) -> ExtrudeTransform
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `surface_name` : `string`
* `extrude_group` : `ExtrudeGroup` - An extrude group is a collection of extrude surfaces.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The height of the extrude group.
height: number,
// The id of the extrude group.
id: uuid,
// The position of the extrude group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-05 16:02:27 -07:00
// The rotation of the extrude group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
// The extrude surfaces.
value: [{
// The id of the geometry.
id: uuid,
// The name.
name: string,
// The position.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-05 16:02:27 -07:00
// The rotation.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
// The source range.
2023-10-11 13:12:21 -05:00
sourceRange: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
}],
}
```
#### Returns
* `ExtrudeTransform`
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
{
2023-10-11 13:12:21 -05:00
position: [number, number, number],
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
}
```
2023-10-13 12:02:46 -07:00
### hole
Use a sketch to cut a hole in another sketch.
```
hole(hole_sketch_group: SketchGroup, sketch_group: SketchGroup) -> SketchGroup
```
#### Arguments
* `hole_sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
// The plane id of the sketch group.
planeId: uuid,
// The position of the sketch group.
position: [number, number, number],
// The rotation of the sketch group.
rotation: [number, number, number, number],
// The starting path.
start: {
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
},
// The paths in the sketch group.
value: [{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
}],
}
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
// The plane id of the sketch group.
planeId: uuid,
// The position of the sketch group.
position: [number, number, number],
// The rotation of the sketch group.
rotation: [number, number, number, number],
// The starting path.
start: {
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
},
// The paths in the sketch group.
value: [{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
// The plane id of the sketch group.
planeId: uuid,
// The position of the sketch group.
position: [number, number, number],
// The rotation of the sketch group.
rotation: [number, number, number, number],
// The starting path.
start: {
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
},
// The paths in the sketch group.
value: [{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
from: [number, number],
// The name of the path.
name: string,
// The to point.
to: [number, number],
type: string,
}],
}
```
2023-09-05 16:02:27 -07:00
### lastSegX
Returns the last segment of x.
```
lastSegX(sketch_group: SketchGroup) -> number
```
#### Arguments
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `number`
### lastSegY
Returns the last segment of y.
```
lastSegY(sketch_group: SketchGroup) -> number
```
#### Arguments
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
#### Returns
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
* `number`
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
### legAngX
Returns the angle of the given leg for x.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
legAngX(hypotenuse: number, leg: number) -> number
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `hypotenuse` : `number`
* `leg` : `number`
#### Returns
* `number`
### legAngY
Returns the angle of the given leg for y.
```
legAngY(hypotenuse: number, leg: number) -> number
```
#### Arguments
* `hypotenuse` : `number`
* `leg` : `number`
#### Returns
* `number`
### legLen
Returns the length of the given leg.
```
legLen(hypotenuse: number, leg: number) -> number
```
#### Arguments
* `hypotenuse` : `number`
* `leg` : `number`
#### Returns
* `number`
### line
Draw a line.
```
line(data: LineData, sketch_group: SketchGroup) -> SketchGroup
```
#### Arguments
* `data` : `LineData` - Data to draw a line.
2023-08-25 13:41:04 -07:00
```
{
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### lineTo
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw a line to a point.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
lineTo(data: LineToData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `LineToData` - Data to draw a line to a point.
2023-08-25 13:41:04 -07:00
```
{
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-08-25 13:41:04 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-15 17:40:57 -07:00
### ln
Computes the natural logarithm of the number.
```
ln(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
### log
Computes the logarithm of the number with respect to an arbitrary base.
The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
```
log(num: number, base: number) -> number
```
#### Arguments
* `num` : `number`
* `base` : `number`
#### Returns
* `number`
### log10
Computes the base 10 logarithm of the number.
```
log10(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
### log2
Computes the base 2 logarithm of the number.
```
log2(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-09-15 15:54:49 -07:00
### max
2023-09-15 17:40:57 -07:00
Computes the maximum of the given arguments.
2023-09-15 15:54:49 -07:00
```
max(args: [number]) -> number
```
#### Arguments
* `args` : `[number]`
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### min
2023-08-25 13:41:04 -07:00
2023-09-15 17:40:57 -07:00
Computes the minimum of the given arguments.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
min(args: [number]) -> number
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `args` : `[number]`
#### Returns
* `number`
2023-09-13 15:09:07 -07:00
### pi
2023-09-15 17:40:57 -07:00
Return the value of `pi` . Archimedes’ constant (π).
2023-09-13 15:09:07 -07:00
```
pi() -> number
```
#### Arguments
#### Returns
* `number`
2023-09-15 15:54:49 -07:00
### pow
Computes the number to a power.
```
pow(num: number, pow: number) -> number
```
#### Arguments
* `num` : `number`
* `pow` : `number`
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### segAng
Returns the angle of the segment.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
segAng(segment_name: string, sketch_group: SketchGroup) -> number
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
#### Arguments
* `segment_name` : `string`
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `number`
### segEndX
Returns the segment end of x.
```
segEndX(segment_name: string, sketch_group: SketchGroup) -> number
```
#### Arguments
* `segment_name` : `string`
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
#### Returns
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
* `number`
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
### segEndY
Returns the segment end of y.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
segEndY(segment_name: string, sketch_group: SketchGroup) -> number
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `segment_name` : `string`
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
2023-09-05 16:02:27 -07:00
* `number`
### segLen
Returns the length of the segment.
```
segLen(segment_name: string, sketch_group: SketchGroup) -> number
```
#### Arguments
* `segment_name` : `string`
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
#### Returns
* `number`
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
### show
Render a model.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
show(sketch: SketchGroup)
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `sketch` : `SketchGroup` - A sketch group is a collection of paths.
2023-08-25 13:41:04 -07:00
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
2023-09-13 15:09:07 -07:00
### sin
Computes the sine of a number (in radians).
```
sin(num: number) -> number
```
#### Arguments
* `num` : `number`
2023-09-15 15:54:49 -07:00
#### Returns
* `number`
### sqrt
Computes the square root of a number.
```
sqrt(num: number) -> number
```
#### Arguments
* `num` : `number`
2023-09-13 15:09:07 -07:00
#### Returns
* `number`
2023-10-05 14:27:48 -07:00
### startProfileAt
Start a profile at a given point.
```
startProfileAt(data: LineData, plane: Plane) -> SketchGroup
```
#### Arguments
* `data` : `LineData` - Data to draw a line.
```
{
// The tag.
tag: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-10-05 14:27:48 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-10-05 14:27:48 -07:00
```
* `plane` : `Plane` - A plane.
```
{
// The id of the plane.
id: uuid,
// Origin of the plane.
origin: {
x: number,
y: number,
z: number,
},
// Type for a plane.
value: string |
string,
// What should the plane’ s X axis be?
xAxis: {
x: number,
y: number,
z: number,
},
// What should the plane’ s Y axis be?
yAxis: {
x: number,
y: number,
z: number,
},
// The z-axis (normal).
zAxis: {
x: number,
y: number,
z: number,
},
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
// The plane id of the sketch group.
planeId: uuid,
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-10-05 14:27:48 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-10-05 14:27:48 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-10-05 14:27:48 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-10-05 14:27:48 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-10-05 14:27:48 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-10-05 14:27:48 -07:00
type: string,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-10-05 14:27:48 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-10-05 14:27:48 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-10-05 14:27:48 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-10-05 14:27:48 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-10-05 14:27:48 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-10-05 14:27:48 -07:00
type: string,
}],
}
```
2023-09-05 16:02:27 -07:00
### startSketchAt
2023-10-05 14:27:48 -07:00
Start a sketch at a given point on the 'XY' plane.
2023-09-05 16:02:27 -07:00
```
startSketchAt(data: LineData) -> SketchGroup
```
#### Arguments
* `data` : `LineData` - Data to draw a line.
```
{
// The tag.
tag: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-09-05 16:02:27 -07:00
```
2023-08-25 13:41:04 -07:00
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-10-05 14:27:48 -07:00
### startSketchOn
Start a sketch at a given point.
```
startSketchOn(data: PlaneData) -> Plane
```
#### Arguments
* `data` : `PlaneData` - Data for a plane.
```
string |
string |
string |
string |
string |
string |
{
plane: {
// Origin of the plane.
origin: {
x: number,
y: number,
z: number,
},
// What should the plane’ s X axis be?
x_axis: {
x: number,
y: number,
z: number,
},
// What should the plane’ s Y axis be?
y_axis: {
x: number,
y: number,
z: number,
},
// The z-axis (normal).
z_axis: {
x: number,
y: number,
z: number,
},
},
}
```
#### Returns
* `Plane` - A plane.
```
{
// The id of the plane.
id: uuid,
// Origin of the plane.
origin: {
x: number,
y: number,
z: number,
},
// Type for a plane.
value: string |
string,
// What should the plane’ s X axis be?
xAxis: {
x: number,
y: number,
z: number,
},
// What should the plane’ s Y axis be?
yAxis: {
x: number,
y: number,
z: number,
},
// The z-axis (normal).
zAxis: {
x: number,
y: number,
z: number,
},
}
```
2023-09-13 15:09:07 -07:00
### tan
Computes the tangent of a number (in radians).
```
tan(num: number) -> number
```
#### Arguments
* `num` : `number`
#### Returns
* `number`
2023-10-12 11:50:54 -05:00
### tangentialArc
2023-09-29 14:41:14 -07:00
Draw an arc.
```
2023-10-12 11:50:54 -05:00
tangentialArc(data: TangentialArcData, sketch_group: SketchGroup) -> SketchGroup
2023-09-29 14:41:14 -07:00
```
#### Arguments
2023-10-12 11:50:54 -05:00
* `data` : `TangentialArcData` - Data to draw a tangential arc.
2023-09-29 14:41:14 -07:00
```
{
// Offset of the arc, in degrees.
offset: number,
// Radius of the arc. Not to be confused with Raiders of the Lost Ark.
radius: number,
} |
{
// The tag.
tag: string,
// Where the arc should end. Must lie in the same plane as the current path pen position. Must not be colinear with current path pen position.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-09-29 14:41:14 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-09-29 14:41:14 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-29 14:41:14 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-29 14:41:14 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-09-29 14:41:14 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-29 14:41:14 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-29 14:41:14 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
}],
}
```
2023-10-12 11:50:54 -05:00
### tangentialArcTo
2023-09-29 14:41:14 -07:00
Draw an arc.
```
2023-10-12 11:50:54 -05:00
tangentialArcTo(data: TangentialArcToData, sketch_group: SketchGroup) -> SketchGroup
2023-09-29 14:41:14 -07:00
```
#### Arguments
2023-10-12 11:50:54 -05:00
* `data` : `TangentialArcToData` - Data to draw a tangential arc to a specific point.
2023-09-29 14:41:14 -07:00
```
{
// The tag.
tag: string,
// Where the arc should end. Must lie in the same plane as the current path pen position. Must not be colinear with current path pen position.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
} |
2023-10-11 13:12:21 -05:00
[number, number]
2023-09-29 14:41:14 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-09-29 14:41:14 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-29 14:41:14 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-29 14:41:14 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-09-29 14:41:14 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-29 14:41:14 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-29 14:41:14 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-29 14:41:14 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-29 14:41:14 -07:00
type: string,
}],
}
```
2023-09-15 17:40:57 -07:00
### tau
Return the value of `tau` . The full circle constant (τ). Equal to 2π.
```
tau() -> number
```
#### Arguments
#### Returns
* `number`
2023-09-05 16:02:27 -07:00
### xLine
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw a line on the x-axis.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
xLine(data: AxisLineData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AxisLineData` - Data to draw a line on an axis.
2023-08-25 13:41:04 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The length of the line.
length: number,
2023-08-25 13:41:04 -07:00
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
} |
number
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-09-05 16:02:27 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-09-05 16:02:27 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-09-05 16:02:27 -07:00
// The starting path.
start: {
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
},
// The paths in the sketch group.
value: [{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
2023-09-05 16:02:27 -07:00
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
// The x coordinate.
x: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-09-05 16:02:27 -07:00
// The name of the path.
name: string,
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
}],
}
2023-08-25 13:41:04 -07:00
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### xLineTo
2023-08-25 13:41:04 -07:00
2023-09-05 16:02:27 -07:00
Draw a line to a point on the x-axis.
2023-08-25 13:41:04 -07:00
```
2023-09-05 16:02:27 -07:00
xLineTo(data: AxisLineToData, sketch_group: SketchGroup) -> SketchGroup
2023-08-25 13:41:04 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AxisLineToData` - Data to draw a line to a point on an axis.
```
{
// The tag.
tag: string,
// The to point.
to: number,
} |
number
```
2023-08-31 22:19:23 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-31 22:19:23 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-31 22:19:23 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-31 22:19:23 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-31 22:19:23 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-31 22:19:23 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-31 22:19:23 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-31 22:19:23 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-31 22:19:23 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### yLine
2023-08-31 22:19:23 -07:00
2023-09-05 16:02:27 -07:00
Draw a line on the y-axis.
2023-08-31 22:19:23 -07:00
```
2023-09-05 16:02:27 -07:00
yLine(data: AxisLineData, sketch_group: SketchGroup) -> SketchGroup
2023-08-31 22:19:23 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AxisLineData` - Data to draw a line on an axis.
2023-08-31 22:19:23 -07:00
```
{
2023-09-05 16:02:27 -07:00
// The length of the line.
length: number,
2023-08-31 22:19:23 -07:00
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
2023-08-31 22:19:23 -07:00
} |
2023-09-05 16:02:27 -07:00
number
2023-08-31 22:19:23 -07:00
```
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-31 22:19:23 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-31 22:19:23 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-31 22:19:23 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-31 22:19:23 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-31 22:19:23 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-31 22:19:23 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-31 22:19:23 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-31 22:19:23 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-31 22:19:23 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-31 22:19:23 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-31 22:19:23 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-31 22:19:23 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-31 22:19:23 -07:00
}],
}
```
2023-09-05 16:02:27 -07:00
### yLineTo
2023-08-31 22:19:23 -07:00
2023-09-05 16:02:27 -07:00
Draw a line to a point on the y-axis.
2023-08-31 22:19:23 -07:00
```
2023-09-05 16:02:27 -07:00
yLineTo(data: AxisLineToData, sketch_group: SketchGroup) -> SketchGroup
2023-08-31 22:19:23 -07:00
```
#### Arguments
2023-09-05 16:02:27 -07:00
* `data` : `AxisLineToData` - Data to draw a line to a point on an axis.
2023-08-31 22:19:23 -07:00
```
{
// The tag.
2023-09-05 16:02:27 -07:00
tag: string,
2023-08-31 22:19:23 -07:00
// The to point.
2023-09-05 16:02:27 -07:00
to: number,
2023-08-31 22:19:23 -07:00
} |
2023-09-05 16:02:27 -07:00
number
2023-08-31 22:19:23 -07:00
```
2023-08-25 13:41:04 -07:00
* `sketch_group` : `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```
#### Returns
* `SketchGroup` - A sketch group is a collection of paths.
```
{
// The id of the sketch group.
2023-09-05 16:02:27 -07:00
id: uuid,
2023-10-05 14:27:48 -07:00
// The plane id of the sketch group.
planeId: uuid,
2023-08-25 13:41:04 -07:00
// The position of the sketch group.
2023-10-11 13:12:21 -05:00
position: [number, number, number],
2023-08-25 13:41:04 -07:00
// The rotation of the sketch group.
2023-10-11 13:12:21 -05:00
rotation: [number, number, number, number],
2023-08-25 13:41:04 -07:00
// The starting path.
2023-09-05 16:02:27 -07:00
start: {
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-08-25 13:41:04 -07:00
},
// The paths in the sketch group.
2023-09-05 16:02:27 -07:00
value: [{
2023-08-25 13:41:04 -07:00
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
// The x coordinate.
2023-09-05 16:02:27 -07:00
x: number,
2023-08-25 13:41:04 -07:00
// The y coordinate.
2023-09-05 16:02:27 -07:00
y: number,
2023-08-25 13:41:04 -07:00
} |
{
// The from point.
2023-10-11 13:12:21 -05:00
from: [number, number],
2023-08-25 13:41:04 -07:00
// The name of the path.
2023-09-05 16:02:27 -07:00
name: string,
2023-08-25 13:41:04 -07:00
// The to point.
2023-10-11 13:12:21 -05:00
to: [number, number],
2023-09-05 16:02:27 -07:00
type: string,
2023-08-25 13:41:04 -07:00
}],
}
```