Files
modeling-app/docs/kcl-std/close.md
Nick Cameron 1841e63021 Misc docs polishing (#6712)
* Fake modules for Rust std lib functions

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

* Include the missing @ in Rust std lib fns

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

* Move revolve and mirror2d to better modules

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

* Use docs from KCL mods for type summaries

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

* Use type docs to describe types from KCL std lib

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 16:09:59 +12:00

169 KiB

title, excerpt, layout
title excerpt layout
std::sketch::close Construct a line segment from the current origin back to the profile's origin, ensuring the resulting 2-dimensional sketch is not open-ended. 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)
  |> startProfile(at = [0, 0])
  |> line(end = [10, 10])
  |> line(end = [10, 0])
  |> close()
  |> extrude(length = 10)

Rendered example of std::sketch::close 0

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

example = extrude(exampleSketch, length = 10)

Rendered example of std::sketch::close 1