kcl-std → functions → hole::holes

hole::holesFunction in std::hole

WARNING: This function is experimental and may change or be removed.

From the hole's parts (bottom, middle, top), cut the hole into the given solid, at each of the given 2D positions on the given face. Basically like function hole but it takes multiple 2D positions in cutsAt.

hole::holes(
  @solid: Solid,
  face: TaggedFace,
  holeBottom,
  holeBody,
  holeType,
  cutsAt: [[number(Length); 2]],
)

Arguments

NameTypeDescriptionRequired
solidSolidWhich solid to add a hole to.Yes
faceTaggedFaceWhich face of the solid to add the hole to. Controls the orientation of the hole.Yes
holeBottomDefine bottom feature of the hole. E.g. drilled or flat.Yes
holeBodyDefine the main length of the hole. E.g. a blind distance.Yes
holeTypeDefine the top feature of the hole. E.g. countersink, counterbore, simple.Yes
cutsAt[[number(Length); 2]]Where to place the holes, given as absolute coordinates in the global scene.Yes
Found a typo?