Files
modeling-app/docs/kcl/close.md
Nick Cameron 89bc93e4cd Add default planes to std (#5433)
* Type ascription

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Support negation of planes

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Add default planes to std

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Don't double wrap docs files in const_

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-02-27 15:58:58 +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