Files
modeling-app/docs/kcl/getOppositeEdge.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

97 KiB

title, excerpt, layout
title excerpt layout
getOppositeEdge Get the opposite edge to the edge given. manual

Get the opposite edge to the edge given.

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

Arguments

Name Type Description Required
edge TagIdentifier The tag of the edge you want to find the opposite edge of. Yes

Returns

Uuid

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> line(end = [10, 0])
  |> angledLine(angle = 60, length = 10)
  |> angledLine(angle = 120, length = 10)
  |> line(end = [-10, 0])
  |> angledLine(angle = 240, length = 10, tag = $referenceEdge)
  |> close()

example = extrude(exampleSketch, length = 5)
  |> fillet(radius = 3, tags = [getOppositeEdge(referenceEdge)])

Rendered example of getOppositeEdge 0