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>
57 lines
169 KiB
Markdown
57 lines
169 KiB
Markdown
---
|
|
title: "close"
|
|
excerpt: "Construct a line segment from the current origin back to the profile's"
|
|
layout: manual
|
|
---
|
|
|
|
Construct a line segment from the current origin back to the profile's
|
|
|
|
origin, ensuring the resulting 2-dimensional sketch is not open-ended.
|
|
|
|
```js
|
|
close(
|
|
sketch: Sketch,
|
|
tag?: TagDeclarator,
|
|
) -> Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | The sketch you want to close | Yes |
|
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
startSketchOn(XZ)
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [10, 10])
|
|
|> line(end = [10, 0])
|
|
|> close()
|
|
|> extrude(length = 10)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
```
|
|
|
|
|
|
|
|
|