ffbe20b586
Previous: ``` startProfileAt([x, y], %) startProfileAt([x, y], sketch001) ``` New: ``` startProfile(%, at = [x, y]) startProfile(sketch001, at = [x, y]) ```
75 lines
322 KiB
Markdown
75 lines
322 KiB
Markdown
---
|
|
title: "startProfile"
|
|
excerpt: "Start a new profile at a given point."
|
|
layout: manual
|
|
---
|
|
|
|
Start a new profile at a given point.
|
|
|
|
|
|
|
|
```js
|
|
startProfile(
|
|
sketchSurface: SketchSurface,
|
|
at: [number],
|
|
tag?: TagDeclarator,
|
|
): Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketchSurface` | [`SketchSurface`](/docs/kcl/types/SketchSurface) | What to start the profile on | Yes |
|
|
| `at` | [`[number]`](/docs/kcl/types/number) | Where to start the profile. An absolute point. | Yes |
|
|
| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Tag this first starting point | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> startProfile(at = [10, 10])
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> startProfile(at = [-10, 23])
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
|