* updates
Signed-off-by: Jess Frazelle <github@jessfraz.com>
* updates
Signed-off-by: Jess Frazelle <github@jessfraz.com>
* updates
Signed-off-by: Jess Frazelle <github@jessfraz.com>
* make tsc happ
* better error msg
* fix control point issue
* basic code gen working for tangentialArc
* partical fix for move with arcs
* tangential arc move
* fix
* make eslint rules less annoying
* inital refactor of some xstate stuff
* more old tangential arc clean up stuff
* more tweaks
* add testing
* tweak xstate inspect
* temp remove test
* update formating for less conflicts
* fix state machine layout after merge
* shrug, something weird with xstate typegen
* renaming some xstate events
* tweak numbers to make CI playwright happ
* CI hacks
* more CI hacks
* more CI hacks
* new hack strategy
* run tests agian
* make cmd bar less flaky
* ci hacks
* CI hacks
* CI hacks
* CI hacks
* clean up
* fix
* still have constraint stuff to deal with
* progress on move rules
* update source ranges after no execute code-mod
* typo
* mvp working
* hide show sketch overlay
* match scaling
* update arrow head style
* animate line tool
* bypass xstate for animations, much smoother
* add new segment working with refactor needed for setup paper sketch
* refactor setup paper sketch
* tangantialArcTo drag animations working
* tangential arc polish
* cargo fmt
* clippy
* more clippy
* mock canvas
* last of clippy?
* typo
* more clippy stuff
* move util function so they are shareable with typescript
* migrate a bunch to rust and only rust
* add arc center point for draft tangential ac
* clippy tweak
* delete uneeded test
* Rough start to scaling arrow heads.
The tangent arrow heads are basically nuked and replaced while the
straight line sections are just rotated and repositioned, this means they
miss out on updating scaling number after a screen size changes.
Needs fixing
* fix bug with tool tips
* fix draft line start position
Having drag the end of teh path before selecting a tooltip would result in the draft line starting where the path used to end, stale data
* some progress with pan maybe
* fmt
* inital camera sync working
For perspective camera at least
* change three.js to use z-up
* add grid
* orthographic camera working with polish items TODO
* fix zoom level when swapping camera
* fix up camera/orbit changing on cam change (pan wasn't being respected)
* tidy up
* use orbit target instead of assuming scene center
* dynamic fov working
* animate orthographic to perspective and reverse
* fix import
* temp fix for batch commands
* initial client side scene sketch working
* remove hover log
* FOV adjust fix
* fix comment
* tear down sketch and small tweaks
* some progress with camera tweening
* combine dollyZoom engine commands
see
https://github.com/KittyCAD/modeling-api/compare/kurt-perspective-settings?expand=1
and
https://github.com/KittyCAD/engine/compare/kurt-perspective-settings?expand=1
* make tests happy (mocks)
* fix tween to vertical/camera-up bug
* tween to each axis with hacky solutions in there
* fix startSketchOn planes
* tidy startSketchOn
* tweening okay for now I think
* get sketching on default planes working
* allow editing on all default planes
* clean up enter and exit sketch logic
* tidy
* tidy
* remove more default plane stuff
* start of draft line
* remove some annoying parts of the paper.js implementation
* fix drag than equip line bug
* comment
* don't animate on skech tear down since it's used for draft line
* remove more default plane shit
* style draft line
* refine dashed line
* draft line set up and tear down mostly happy
* add on click logic ready for draft lines
* sketch mode with drag and draft mode working solidly now, straight segments only
* default planes match colors, hover and select still TODO
* hover and click logic working for default planes
Now just need the code mode to fire to 'startSketchOn(...)'
* select default planes
* remove some logs
* fix update infinite loop
* start of orbitControls port to Franks control guards
* hiding scenes at different times
* scene hide on camera move should be respected by scroll zoom
* basic hover working
* Hook up user camera settings to ClientSideScene (#1334)
* Refactor to not import utilities from Router.tsx
* Stop tracking changes or formatting *.typegen.ts
* Hook up cameraControls to ClientSideScene
* Remove camera controls toggle from temp debug panel
---------
Co-authored-by: Kurt Hutten Irev-Dev <k.hutten@protonmail.ch>
* add select segment moves cursor
* highlight segments yellow on hover
* cursor ranges effect 2d line colors
* fix constrainst i.e. make sure the sketch is rejiged
* selecting nothing should remove selections
* remove hardcoded strings
* update get_tangential_arc_to_info rust util
* initial drawing of tangential arcs in client scene
* fix tangentialArc arrow head direction
* correct userData types for tangential arcs
* get tangential arc updates working
Doesn't include draging the head of the tangential arc itself yet
* spot of clean up
* make selections work with tangential arcs
* get draft tangential segment animated
* fix initial click weirdness for adding new tangential line
* couple tweaks
* add grace pixels /threshold to raycast
* redo arc dashes so that they spawn from the ccenter of the arc
* fix multi drag bug
* fmt
* add temp solution for close
* add default axis hover colors, still needs select logic
* selection of axis works, just with out selection color
* get axis selection colors working
* fix outdate source ranges after drag problem
* update moreNodePathFromSourceRange
* fix ts-rs issue/workaround
* fix default plane weirdness
* fix tangential arc rounding issue
* review clean up part 1
* review clean up part 2
Big state-diagram cull
* clippy
* typo
* clippy
* fix xstate types with typegen
* fix types
* clippy
* catch error
* fix test import issue
Not sure exactly what was happening but guessing circular import that vite didn't like
* add axis/plane info to sketch group tests
* case changes because of rs-ts bug, can probably revert this later
* start of playwright test fixes
* reduce geo complexity for straight segments
* fix cam adjust tests
* Revert "Clean up vite build warnings (#1332)"
This reverts commit c1f661ab52
.
* selection e2e test fixed<
* remove camToggle to allow playwright tests to pass
* remove drag test
too brittle and needs to be redone from the ground up anyway
* trigger CI
* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)
* fix last test
* clean up part 3
* clean up part 4
* clean up part 5
* clean up sketch enter exit logic
* fix engine side selections
* default plane should not be selected form 'onDragEnd'
i.e. rotating the camera should not mean the user acidently selects a plane
* clean up state diagram around animating to sketch mode
Embracing that the animation is async and puting the interdiate steps in the state diagram clean up some logic and solved some bugs at the same time
* add test for multiple sketches
* typo
* make highlight more robust
* type tweak
* scale segmenst with distance from camera so they have a consistent pixel size/ screenspace size
* Jess's advice
* tsc and fmt
* clean up part 6
remove integer from xstate names
* clean up part 7
* integrate sequency in to camera moves
* fix tests
* update snapshot e2e
* small snapshot change
* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)
* trigger ci
* Fix HomeLoaderData types
* update std stuff
* update kittycad rs client lib
---------
Signed-off-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: Frank Noirot <frank@kittycad.io>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
5633 lines
102 KiB
Markdown
5633 lines
102 KiB
Markdown
<!--- DO NOT EDIT THIS FILE. IT IS AUTOMATICALLY GENERATED. -->
|
||
|
||
# KCL Standard Library
|
||
|
||
## Table of Contents
|
||
|
||
* [Functions](#functions)
|
||
* [`abs`](#abs)
|
||
* [`acos`](#acos)
|
||
* [`angleToMatchLengthX`](#angleToMatchLengthX)
|
||
* [`angleToMatchLengthY`](#angleToMatchLengthY)
|
||
* [`angledLine`](#angledLine)
|
||
* [`angledLineOfXLength`](#angledLineOfXLength)
|
||
* [`angledLineOfYLength`](#angledLineOfYLength)
|
||
* [`angledLineThatIntersects`](#angledLineThatIntersects)
|
||
* [`angledLineToX`](#angledLineToX)
|
||
* [`angledLineToY`](#angledLineToY)
|
||
* [`arc`](#arc)
|
||
* [`asin`](#asin)
|
||
* [`atan`](#atan)
|
||
* [`bezierCurve`](#bezierCurve)
|
||
* [`ceil`](#ceil)
|
||
* [`close`](#close)
|
||
* [`cos`](#cos)
|
||
* [`e`](#e)
|
||
* [`extrude`](#extrude)
|
||
* [`floor`](#floor)
|
||
* [`getExtrudeWallTransform`](#getExtrudeWallTransform)
|
||
* [`hole`](#hole)
|
||
* [`lastSegX`](#lastSegX)
|
||
* [`lastSegY`](#lastSegY)
|
||
* [`legAngX`](#legAngX)
|
||
* [`legAngY`](#legAngY)
|
||
* [`legLen`](#legLen)
|
||
* [`line`](#line)
|
||
* [`lineTo`](#lineTo)
|
||
* [`ln`](#ln)
|
||
* [`log`](#log)
|
||
* [`log10`](#log10)
|
||
* [`log2`](#log2)
|
||
* [`max`](#max)
|
||
* [`min`](#min)
|
||
* [`pi`](#pi)
|
||
* [`pow`](#pow)
|
||
* [`segAng`](#segAng)
|
||
* [`segEndX`](#segEndX)
|
||
* [`segEndY`](#segEndY)
|
||
* [`segLen`](#segLen)
|
||
* [`show`](#show)
|
||
* [`sin`](#sin)
|
||
* [`sqrt`](#sqrt)
|
||
* [`startProfileAt`](#startProfileAt)
|
||
* [`startSketchAt`](#startSketchAt)
|
||
* [`startSketchOn`](#startSketchOn)
|
||
* [`tan`](#tan)
|
||
* [`tangentialArc`](#tangentialArc)
|
||
* [`tangentialArcTo`](#tangentialArcTo)
|
||
* [`tau`](#tau)
|
||
* [`xLine`](#xLine)
|
||
* [`xLineTo`](#xLineTo)
|
||
* [`yLine`](#yLine)
|
||
* [`yLineTo`](#yLineTo)
|
||
|
||
|
||
## Functions
|
||
|
||
### 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`
|
||
|
||
|
||
|
||
### angleToMatchLengthX
|
||
|
||
Returns the angle to match the given length for x.
|
||
|
||
|
||
|
||
```
|
||
angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `segment_name`: `string`
|
||
* `to`: `number`
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### angleToMatchLengthY
|
||
|
||
Returns the angle to match the given length for y.
|
||
|
||
|
||
|
||
```
|
||
angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `segment_name`: `string`
|
||
* `to`: `number`
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### angledLine
|
||
|
||
Draw an angled line.
|
||
|
||
|
||
|
||
```
|
||
angledLine(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `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,
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### angledLineOfXLength
|
||
|
||
Draw an angled line of a given x length.
|
||
|
||
|
||
|
||
```
|
||
angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `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,
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### angledLineOfYLength
|
||
|
||
Draw an angled line of a given y length.
|
||
|
||
|
||
|
||
```
|
||
angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `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,
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### angledLineThatIntersects
|
||
|
||
Draw an angled line that intersects with a given line.
|
||
|
||
|
||
|
||
```
|
||
angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AngledLineThatIntersectsData` - 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,
|
||
}
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### angledLineToX
|
||
|
||
Draw an angled line to a given x coordinate.
|
||
|
||
|
||
|
||
```
|
||
angledLineToX(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AngledLineToData` - Data to draw an angled line to a point.
|
||
```
|
||
{
|
||
// The angle of the line.
|
||
angle: number,
|
||
// The tag.
|
||
tag: string,
|
||
// The point to draw to.
|
||
to: number,
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### angledLineToY
|
||
|
||
Draw an angled line to a given y coordinate.
|
||
|
||
|
||
|
||
```
|
||
angledLineToY(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AngledLineToData` - Data to draw an angled line to a point.
|
||
```
|
||
{
|
||
// The angle of the line.
|
||
angle: number,
|
||
// The tag.
|
||
tag: string,
|
||
// The point to draw to.
|
||
to: number,
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### arc
|
||
|
||
Draw an arc.
|
||
|
||
|
||
|
||
```
|
||
arc(data: ArcData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `ArcData` - Data to draw an arc.
|
||
```
|
||
{
|
||
// 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.
|
||
center: [number, number],
|
||
// The radius.
|
||
radius: number,
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: [number, number],
|
||
} |
|
||
{
|
||
// The center.
|
||
center: [number, number],
|
||
// The radius.
|
||
radius: number,
|
||
// The to point.
|
||
to: [number, number],
|
||
}
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### 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`
|
||
|
||
|
||
|
||
### bezierCurve
|
||
|
||
Draw a bezier curve.
|
||
|
||
|
||
|
||
```
|
||
bezierCurve(data: BezierData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `BezierData` - Data to draw a bezier curve.
|
||
```
|
||
{
|
||
// The first control point.
|
||
control1: [number, number],
|
||
// The second control point.
|
||
control2: [number, number],
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: [number, number],
|
||
} |
|
||
{
|
||
// The first control point.
|
||
control1: [number, number],
|
||
// The second control point.
|
||
control2: [number, number],
|
||
// The to point.
|
||
to: [number, number],
|
||
}
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### ceil
|
||
|
||
Computes the smallest integer greater than or equal to a number.
|
||
|
||
|
||
|
||
```
|
||
ceil(num: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### close
|
||
|
||
Close the current sketch.
|
||
|
||
|
||
|
||
```
|
||
close(sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### cos
|
||
|
||
Computes the sine of a number (in radians).
|
||
|
||
|
||
|
||
```
|
||
cos(num: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### e
|
||
|
||
Return the value of Euler’s number `e`.
|
||
|
||
|
||
|
||
```
|
||
e() -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### extrude
|
||
|
||
Extrudes by a given amount.
|
||
|
||
|
||
|
||
```
|
||
extrude(length: number, sketch_group: SketchGroup) -> ExtrudeGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `length`: `number`
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `ExtrudeGroup` - An extrude group is a collection of extrude surfaces.
|
||
```
|
||
{
|
||
// The height of the extrude group.
|
||
height: number,
|
||
// The id of the extrude group.
|
||
id: uuid,
|
||
// The position of the extrude group.
|
||
position: [number, number, number],
|
||
// The rotation of the extrude group.
|
||
rotation: [number, number, number, number],
|
||
// The extrude surfaces.
|
||
value: [{
|
||
// The id of the geometry.
|
||
id: uuid,
|
||
// The name.
|
||
name: string,
|
||
// The position.
|
||
position: [number, number, number],
|
||
// The rotation.
|
||
rotation: [number, number, number, number],
|
||
// The source range.
|
||
sourceRange: [number, number],
|
||
type: string,
|
||
}],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### floor
|
||
|
||
Computes the largest integer less than or equal to a number.
|
||
|
||
|
||
|
||
```
|
||
floor(num: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### getExtrudeWallTransform
|
||
|
||
Returns the extrude wall transform.
|
||
|
||
|
||
|
||
```
|
||
getExtrudeWallTransform(surface_name: string, extrude_group: ExtrudeGroup) -> ExtrudeTransform
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `surface_name`: `string`
|
||
* `extrude_group`: `ExtrudeGroup` - An extrude group is a collection of extrude surfaces.
|
||
```
|
||
{
|
||
// The height of the extrude group.
|
||
height: number,
|
||
// The id of the extrude group.
|
||
id: uuid,
|
||
// The position of the extrude group.
|
||
position: [number, number, number],
|
||
// The rotation of the extrude group.
|
||
rotation: [number, number, number, number],
|
||
// The extrude surfaces.
|
||
value: [{
|
||
// The id of the geometry.
|
||
id: uuid,
|
||
// The name.
|
||
name: string,
|
||
// The position.
|
||
position: [number, number, number],
|
||
// The rotation.
|
||
rotation: [number, number, number, number],
|
||
// The source range.
|
||
sourceRange: [number, number],
|
||
type: string,
|
||
}],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `ExtrudeTransform`
|
||
```
|
||
{
|
||
position: [number, number, number],
|
||
rotation: [number, number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### 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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### lastSegX
|
||
|
||
Returns the last segment of x.
|
||
|
||
|
||
|
||
```
|
||
lastSegX(sketch_group: SketchGroup) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `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.
|
||
```
|
||
{
|
||
// 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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### legAngX
|
||
|
||
Returns the angle of the given leg for x.
|
||
|
||
|
||
|
||
```
|
||
legAngX(hypotenuse: number, leg: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `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.
|
||
```
|
||
{
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: [number, number],
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### lineTo
|
||
|
||
Draw a line to a point.
|
||
|
||
|
||
|
||
```
|
||
lineTo(data: LineToData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `LineToData` - Data to draw a line to a point.
|
||
```
|
||
{
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: [number, number],
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### 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`
|
||
|
||
|
||
|
||
### max
|
||
|
||
Computes the maximum of the given arguments.
|
||
|
||
|
||
|
||
```
|
||
max(args: [number]) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `args`: `[number]`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### min
|
||
|
||
Computes the minimum of the given arguments.
|
||
|
||
|
||
|
||
```
|
||
min(args: [number]) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `args`: `[number]`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### pi
|
||
|
||
Return the value of `pi`. Archimedes’ constant (π).
|
||
|
||
|
||
|
||
```
|
||
pi() -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### pow
|
||
|
||
Computes the number to a power.
|
||
|
||
|
||
|
||
```
|
||
pow(num: number, pow: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
* `pow`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### segAng
|
||
|
||
Returns the angle of the segment.
|
||
|
||
|
||
|
||
```
|
||
segAng(segment_name: string, sketch_group: SketchGroup) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `segment_name`: `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `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.
|
||
```
|
||
{
|
||
// 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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### segEndY
|
||
|
||
Returns the segment end of y.
|
||
|
||
|
||
|
||
```
|
||
segEndY(segment_name: string, sketch_group: SketchGroup) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `segment_name`: `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `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.
|
||
```
|
||
{
|
||
// 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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### show
|
||
|
||
Render a model.
|
||
|
||
|
||
|
||
```
|
||
show(sketch: SketchGroup)
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `sketch`: `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### sin
|
||
|
||
Computes the sine of a number (in radians).
|
||
|
||
|
||
|
||
```
|
||
sin(num: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### sqrt
|
||
|
||
Computes the square root of a number.
|
||
|
||
|
||
|
||
```
|
||
sqrt(num: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### 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.
|
||
to: [number, number],
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### startSketchAt
|
||
|
||
Start a sketch at a given point on the 'XY' plane.
|
||
|
||
|
||
|
||
```
|
||
startSketchAt(data: LineData) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `LineData` - Data to draw a line.
|
||
```
|
||
{
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: [number, number],
|
||
} |
|
||
[number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### 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,
|
||
},
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### tan
|
||
|
||
Computes the tangent of a number (in radians).
|
||
|
||
|
||
|
||
```
|
||
tan(num: number) -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `num`: `number`
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### tangentialArc
|
||
|
||
Draw an arc.
|
||
|
||
|
||
|
||
```
|
||
tangentialArc(data: TangentialArcData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `TangentialArcData` - Data to draw a tangential arc.
|
||
```
|
||
{
|
||
// 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.
|
||
to: [number, number],
|
||
} |
|
||
[number, number]
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### tangentialArcTo
|
||
|
||
Draw an arc.
|
||
|
||
|
||
|
||
```
|
||
tangentialArcTo(to: [number], sketch_group: SketchGroup, tag: String) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `to`: `[number]`
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
* `tag`: `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### tau
|
||
|
||
Return the value of `tau`. The full circle constant (τ). Equal to 2π.
|
||
|
||
|
||
|
||
```
|
||
tau() -> number
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
|
||
#### Returns
|
||
|
||
* `number`
|
||
|
||
|
||
|
||
### xLine
|
||
|
||
Draw a line on the x-axis.
|
||
|
||
|
||
|
||
```
|
||
xLine(data: AxisLineData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AxisLineData` - Data to draw a line on an axis.
|
||
```
|
||
{
|
||
// The length of the line.
|
||
length: number,
|
||
// The tag.
|
||
tag: string,
|
||
} |
|
||
number
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### xLineTo
|
||
|
||
Draw a line to a point on the x-axis.
|
||
|
||
|
||
|
||
```
|
||
xLineTo(data: AxisLineToData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AxisLineToData` - Data to draw a line to a point on an axis.
|
||
```
|
||
{
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: number,
|
||
} |
|
||
number
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### yLine
|
||
|
||
Draw a line on the y-axis.
|
||
|
||
|
||
|
||
```
|
||
yLine(data: AxisLineData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AxisLineData` - Data to draw a line on an axis.
|
||
```
|
||
{
|
||
// The length of the line.
|
||
length: number,
|
||
// The tag.
|
||
tag: string,
|
||
} |
|
||
number
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|
||
### yLineTo
|
||
|
||
Draw a line to a point on the y-axis.
|
||
|
||
|
||
|
||
```
|
||
yLineTo(data: AxisLineToData, sketch_group: SketchGroup) -> SketchGroup
|
||
```
|
||
|
||
#### Arguments
|
||
|
||
* `data`: `AxisLineToData` - Data to draw a line to a point on an axis.
|
||
```
|
||
{
|
||
// The tag.
|
||
tag: string,
|
||
// The to point.
|
||
to: number,
|
||
} |
|
||
number
|
||
```
|
||
* `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 base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, 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.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
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,
|
||
} |
|
||
{
|
||
// arc's direction
|
||
ccw: string,
|
||
// the arc's center
|
||
center: [number, number],
|
||
// 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,
|
||
}],
|
||
// The x-axis of the sketch group base plane in the 3D space
|
||
xAxis: [number, number, number],
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: [number, number, number],
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: [number, number, number],
|
||
}
|
||
```
|
||
|
||
|
||
|