Files
modeling-app/docs/kcl/getCommonEdge.md
Nick Cameron c050739f41 Some improvements to the boxed signatures in the docs (#6593)
* Show a more reasonable name in function docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Fix buggy docs for union types

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Make types in the docs signatures into links

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-04-30 16:03:22 +00:00

188 KiB

title, excerpt, layout
title excerpt layout
getCommonEdge Get the shared edge between two faces. manual

Get the shared edge between two faces.

getCommon[Edge](/docs/kcl/types/Edge)(faces: [[TagIdentifier](/docs/kcl/types#tag-identifier)]): Uuid

Arguments

Name Type Description Required
faces [TagIdentifier] The tags of the faces you want to find the common edge between Yes

Returns

Uuid

Examples

// Get an edge shared between two faces, created after a chamfer.


scale = 20
part001 = startSketchOn(XY)
  |> startProfile(at = [0, 0])
  |> line(end = [0, scale])
  |> line(end = [scale, 0])
  |> line(end = [0, -scale])
  |> close(tag = $line0)
  |> extrude(length = 20, tagEnd = $end0)
  // We tag the chamfer to reference it later.
  |> chamfer(length = 10, tags = [getOppositeEdge(line0)], tag = $chamfer0)

// Get the shared edge between the chamfer and the extrusion.
commonEdge = getCommonEdge(faces = [chamfer0, end0])

// Chamfer the shared edge.
// TODO: uncomment this when ssi for fillets lands
// chamfer(part001, length = 5, tags = [commonEdge])

Rendered example of getCommonEdge 0