modeling-app/docs/kcl/hole.md

title, excerpt, layout

title	excerpt	layout
hole	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.

hole(hole_sketch: SketchSet, sketch: Sketch) -> Sketch

Arguments

Name	Type	Description	Required
hole_sketch	SketchSet	A sketch or a group of sketches.	Yes
sketch	Sketch	A sketch is a collection of paths.	Yes

Returns

Sketch - A sketch is a collection of paths.

Examples

const exampleSketch = startSketchOn('XY')
  |> startProfileAt([0, 0], %)
  |> line([0, 5], %)
  |> line([5, 0], %)
  |> line([0, -5], %)
  |> close(%)
  |> hole(circle({ center: [1, 1], radius: .25 }, %), %)
  |> hole(circle({ center: [1, 4], radius: .25 }, %), %)

const example = extrude(1, exampleSketch)

fn squareHoleSketch = () => {
  const squareSketch = startSketchOn('-XZ')
    |> startProfileAt([-1, -1], %)
    |> line([2, 0], %)
    |> line([0, 2], %)
    |> line([-2, 0], %)
    |> close(%)
  return squareSketch
}

const exampleSketch = startSketchOn('-XZ')
  |> circle({ center: [0, 0], radius: 3 }, %)
  |> hole(squareHoleSketch(), %)
const example = extrude(1, exampleSketch)