modeling-app/docs/kcl-std/functions/std-sketch-close.md

title, subtitle, excerpt, layout

title	subtitle	excerpt	layout
close	Function in std::sketch	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.

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

Arguments

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

Returns

Sketch - A sketch is a collection of paths.

Description

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.

Function signature

close(
  @sketch: Sketch,
  tag?: TagDecl,
): Sketch

Examples

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

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

example = extrude(exampleSketch, length = 10)