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

62
docs/kcl-std/functions/std-sketch-sweep.md
View File

@ -8,26 +8,28 @@ layout: manual
Extrude a sketch along a path.
```kcl
sweep(
@sketches: [Sketch; 1+],
path: Sketch | Helix,
sectional?: bool,
tolerance?: number(Length),
relativeTo?: string,
tagStart?: TagDecl,
tagEnd?: TagDecl,
): [Solid; 1+]
// Create a pipe using a sweep.
// Create a path for the sweep.
sweepPath = startSketchOn(XZ)
|> startProfile(at = [0.05, 0.05])
|> line(end = [0, 7])
|> tangentialArc(angle = 90deg, radius = 5)
|> line(end = [-3, 0])
|> tangentialArc(angle = -90deg, radius = 5)
|> line(end = [0, 7])
// Create a hole for the pipe.
pipeHole = startSketchOn(XY)
|> circle(center = [0, 0], radius = 1.5)
sweepSketch = startSketchOn(XY)
|> circle(center = [0, 0], radius = 2)
|> subtract2d(tool = pipeHole)
|> sweep(path = sweepPath)
```
This, like extrude, is able to create a 3-dimensional solid from a
2-dimensional sketch. However, unlike extrude, this creates a solid
by using the extent of the sketch as its path. This is useful for
creating more complex shapes that can't be created with a simple
extrusion.
You can provide more than one sketch to sweep, and they will all be
swept along the same path.
### Arguments
| Name | Type | Description | Required |
@ -44,6 +46,30 @@ swept along the same path.
[`[Solid; 1+]`](/docs/kcl-std/types/std-types-Solid)
### Description
This, like extrude, is able to create a 3-dimensional solid from a
2-dimensional sketch. However, unlike extrude, this creates a solid
by using the extent of the sketch as its path. This is useful for
creating more complex shapes that can't be created with a simple
extrusion.
You can provide more than one sketch to sweep, and they will all be
swept along the same path.
### Function signature
```kcl
sweep(
@sketches: [Sketch; 1+],
path: Sketch | Helix,
sectional?: bool,
tolerance?: number(Length),
relativeTo?: string,
tagStart?: TagDecl,
tagEnd?: TagDecl,
): [Solid; 1+]
```
### Examples