56 lines
98 KiB
Markdown
56 lines
98 KiB
Markdown
![]() |
---
|
||
|
title: "sweep"
|
||
|
excerpt: "Extrude a sketch along a path."
|
||
|
layout: manual
|
||
|
---
|
||
|
|
||
|
Extrude a sketch along a path.
|
||
|
|
||
|
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.
|
||
|
|
||
|
```js
|
||
|
sweep(data: SweepData, sketch: Sketch) -> Solid
|
||
|
```
|
||
|
|
||
|
|
||
|
### Arguments
|
||
|
|
||
|
| Name | Type | Description | Required |
|
||
|
|----------|------|-------------|----------|
|
||
|
| `data` | [`SweepData`](/docs/kcl/types/SweepData) | Data for a sweep. | Yes |
|
||
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||
|
|
||
|
### Returns
|
||
|
|
||
|
[`Solid`](/docs/kcl/types/Solid) - An solid is a collection of extrude surfaces.
|
||
|
|
||
|
|
||
|
### Examples
|
||
|
|
||
|
```js
|
||
|
// Create a pipe using a sweep.
|
||
|
|
||
|
|
||
|
// Create a path for the sweep.
|
||
|
sweepPath = startSketchOn('XZ')
|
||
|
|> startProfileAt([0.05, 0.05], %)
|
||
|
|> line([0, 7], %)
|
||
|
|> tangentialArc({ offset = 90, radius = 5 }, %)
|
||
|
|> line([-3, 0], %)
|
||
|
|> tangentialArc({ offset = -90, radius = 5 }, %)
|
||
|
|> line([0, 7], %)
|
||
|
|
||
|
sweepSketch = startSketchOn('XY')
|
||
|
|> startProfileAt([2, 0], %)
|
||
|
|> arc({
|
||
|
angleEnd = 360,
|
||
|
angleStart = 0,
|
||
|
radius = 2
|
||
|
}, %)
|
||
|
|> sweep({ path = sweepPath }, %)
|
||
|
```
|
||
|
|
||
|
![Rendered example of sweep 0](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAYAAADPfd1WAAEgWElEQVR4Ae3AA6AkWZbG8f937o3IzKdyS2Oubdu2bdu2bdu2bWmMnpZKr54yMyLu+Xa3anqmhztr1a8+6EEP4qqrrrrqqquuuuqqq6666qqrrrrqqquu+j+JylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVS+Sa6655sE805kzZx4McM011zyYZzpz5syDeC7XXHPNg3k+rrnmmgfzAtx333238gLcd999t/JMZ8+efQbPdN99993KM509e/bW++6771auuuqqq6666qqrrrrqqquAylVXXXXVVVf9P3TNNdc8GODMmTMPvuaaax585syZB/FM11xzzYOvueaaBwOcOXPmwddcc82DeS733Xffrddcc82DeYDd3V12d3e53+7uLi/I2bNneUFOnDjBC/KQhzyEB3rwgx/MC3PffffdCnD27Nlb77vvvlsB/uEf/uF3AO67775bz549e+t99913K1ddddVVV1111VVXXXXV/1XoQQ96EFddddVVV131f80111zz4DNnzjz4mmuuefCZM2ceBPDiL/7ir33mzJkHX3PNNQ/m+bj11lvZ3d0FYHd3F4Dd3V12d3e53+7uLru7u/xXk8SL4vjx49zv+PHjHD9+HIBjx45x/PhxAI4fP86DH/xg7nfffffdCvAP//APvw3wD//wD7/zD//wD79933333cpVV1111VVXXXXVVVdd9b8detCDHsRVV1111VVX/W91zTXXPPjMmTMPfrEXe7HXuuaaax58zTXXPPjFXuzFXpsHuPXWW9nd3WV3dxeAW2+9FYDd3V12d3f5l0ji/6Ljx48DcPz4cY4fP86DHvQgjh8/zoMf/GAA7rvvvlv/4R/+4bf/4R/+4Xd+67d+67u56qqrrrrqqquuuuqqq/43Qg960IO46qqrrrrqqv8tXuzFXuy1X+zFXuy1XvzFX/y1X+zFXuy1eabd3V1uvfVWdnd3ecYzngHArbfeyv9WkvjvdPz4cR70oAfx4Ac/mJd6qZfivvvuu/W3fuu3vvtHf/RHP4errrrqqquuuuqqq6666n8T9KAHPYirrrrqqquu+p/qmmuuefCLvdiLvfbrvM7rvNeLvdiLvTbA7u4uf/3Xfw3A3/zN37C7u8t/NEn8e11zzTVP+eAP/uCH80xnz5596jd90zc9jP9lTpw4wYMe9CBe6qVeij/+4z/+7N/+7d/+nvvuu+9Wrrrqqquuuuqqq6666qr/DahcddVVV1111f9A11xzzYNf+7Vf+73e6Z3e6b
|
||
|
|
||
|
|