Files
modeling-app/docs/kcl/close.md
Nick Cameron 1104d908c0 Improve hover tool tips and function docs (#5538)
* 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>
2025-02-27 22:03:37 +13:00

169 KiB

title, excerpt, layout
title excerpt layout
close Construct a line segment from the current origin back to the profile's 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.

close(
  sketch: Sketch,
  tag?: TagDeclarator,
) -> Sketch

Arguments

Name Type Description Required
sketch Sketch The sketch you want to close Yes
tag TagDeclarator Create a new tag which refers to this line No

Returns

Sketch - A sketch is a collection of paths.

Examples

startSketchOn(XZ)
  |> startProfileAt([0, 0], %)
  |> line(end = [10, 10])
  |> line(end = [10, 0])
  |> close()
  |> extrude(length = 10)

Rendered example of close 0

exampleSketch = startSketchOn(-XZ)
  |> startProfileAt([0, 0], %)
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of close 1