1104d908c0
* Improve hover tool tips and function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) * A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores) --------- Signed-off-by: Nick Cameron <nrc@ncameron.org> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
75 lines
322 KiB
Markdown
75 lines
322 KiB
Markdown
---
|
|
title: "startProfileAt"
|
|
excerpt: "Start a new profile at a given point."
|
|
layout: manual
|
|
---
|
|
|
|
Start a new profile at a given point.
|
|
|
|
|
|
|
|
```js
|
|
startProfileAt(
|
|
to: [number],
|
|
sketchSurface: SketchSurface,
|
|
tag?: TagDeclarator,
|
|
) -> Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `to` | `[number]` | | Yes |
|
|
| `sketchSurface` | [`SketchSurface`](/docs/kcl/types/SketchSurface) | A sketch type. | Yes |
|
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> startProfileAt([10, 10], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> startProfileAt([-10, 23], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
|