c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
42 lines
78 KiB
Markdown
42 lines
78 KiB
Markdown
---
|
|
title: "profileStart"
|
|
excerpt: "Extract the provided 2-dimensional sketch's profile's origin value."
|
|
layout: manual
|
|
---
|
|
|
|
Extract the provided 2-dimensional sketch's profile's origin value.
|
|
|
|
|
|
|
|
```kcl
|
|
profileStart(profile: [Sketch](/docs/kcl/types/Sketch)): [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number))
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `profile` | [`Sketch`](/docs/kcl/types/Sketch) | Profile whose start is being used | Yes |
|
|
|
|
### Returns
|
|
|
|
[`[number]`](/docs/kcl/types/number)
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
sketch001 = startSketchOn(XY)
|
|
|> startProfile(at = [5, 2])
|
|
|> angledLine(angle = 120, length = 50, tag = $seg01)
|
|
|> angledLine(angle = segAng(seg01) + 120, length = 50)
|
|
|> line(end = profileStart(%))
|
|
|> close()
|
|
|> extrude(length = 20)
|
|
```
|
|
|
|
|
|
|
|
|