ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make the function signature less prominent, add an early example to docs

Browse Source 
Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-06-19 17:08:46 +12:00
parent 6358eed7e4
commit ff1be99351
99 changed files with 2137 additions and 686 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/kcl-std/functions/std-sketch-getCommonEdge.md
View File

@ -8,11 +8,29 @@ layout: manual
Get the shared edge between two faces.
```kcl
getCommonEdge(faces: [TaggedFace; 2]): Edge
// 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])
```
### Arguments
| Name | Type | Description | Required |
@ -24,6 +42,12 @@ getCommonEdge(faces: [TaggedFace; 2]): Edge
[`Edge`](/docs/kcl-std/types/std-types-Edge) - An edge of a solid.
### Function signature
```kcl
getCommonEdge(faces: [TaggedFace; 2]): Edge
```
### Examples
```kcl