3936017f10
* Replace tag type with tagIdent and tagDecl Signed-off-by: Nick Cameron <nrc@ncameron.org> * Replace tagIdent with TaggedEdge and TaggedFace Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
62 lines
169 KiB
Markdown
62 lines
169 KiB
Markdown
---
|
|
title: "close"
|
|
subtitle: "Function in std::sketch"
|
|
excerpt: "Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended."
|
|
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.
|
|
|
|
```kcl
|
|
close(
|
|
@sketch: Sketch,
|
|
tag?: TagDecl,
|
|
): Sketch
|
|
```
|
|
|
|
If you want to perform some 3-dimensional operation on a sketch, like
|
|
extrude or sweep, you must `close` it first. `close` must be called even
|
|
if the end point of the last segment is coincident with the sketch
|
|
starting point.
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | The sketch you want to close. | Yes |
|
|
| `tag` | [`TagDecl`](/docs/kcl-std/types/std-types-TagDecl) | Create a new tag which refers to this line. | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
startSketchOn(XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> line(end = [10, 10])
|
|
|> line(end = [10, 0])
|
|
|> close()
|
|
|> extrude(length = 10)
|
|
|
|
```
|
|
|
|
|
|
|
|
```kcl
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
|
|
```
|
|
|
|
|
|
|
|
|