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

title, subtitle, excerpt, layout

title	subtitle	excerpt	layout
subtract2d	Function in std::sketch	Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.	manual

Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.

subtract2d(
  @sketch: Sketch,
  tool: [Sketch; 1+],
): Sketch

Arguments

Name	Type	Description	Required
sketch	Sketch	Which sketch should this path be added to?	Yes
tool	[Sketch; 1+]	The shape(s) which should be cut out of the sketch.	Yes

Returns

Sketch - A sketch is a collection of paths.

Examples

exampleSketch = startSketchOn(XY)
  |> startProfile(at = [0, 0])
  |> line(end = [0, 5])
  |> line(end = [5, 0])
  |> line(end = [0, -5])
  |> close()
  |> subtract2d(tool =circle( center = [1, 1], radius = .25 ))
  |> subtract2d(tool =circle( center = [1, 4], radius = .25 ))

example = extrude(exampleSketch, length = 1)

fn squareHoleSketch() {
  squareSketch = startSketchOn(-XZ)
    |> startProfile(at = [-1, -1])
    |> line(end = [2, 0])
    |> line(end = [0, 2])
    |> line(end = [-2, 0])
    |> close()
  return squareSketch
}

exampleSketch = startSketchOn(-XZ)
    |> circle( center = [0, 0], radius = 3 )
    |> subtract2d(tool = squareHoleSketch())
example = extrude(exampleSketch, length = 1)