kcl-std → functions → close

closeFunction 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.

close(
  @sketch: Sketch,
  tag?: tag,
): 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`	The sketch you want to close.	Yes
`tag`	`tag`	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 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 close 1

Found a typo?