099c48cd63
* updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix docs; Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * parens Signed-off-by: Jess Frazelle <github@jessfraz.com> * parens Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
44 lines
185 KiB
Markdown
44 lines
185 KiB
Markdown
---
|
|
title: "helixRevolutions"
|
|
excerpt: "Create a helix on a cylinder."
|
|
layout: manual
|
|
---
|
|
|
|
Create a helix on a cylinder.
|
|
|
|
|
|
|
|
```js
|
|
helixRevolutions(data: HelixRevolutionsData, solid: Solid) -> Solid
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `data` | [`HelixRevolutionsData`](/docs/kcl/types/HelixRevolutionsData) | Data for helix revolutions. | Yes |
|
|
| `solid` | [`Solid`](/docs/kcl/types/Solid) | A solid is a collection of extrude surfaces. | Yes |
|
|
|
|
### Returns
|
|
|
|
[`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
part001 = startSketchOn('XY')
|
|
|> circle({ center = [5, 5], radius = 10 }, %)
|
|
|> extrude(length = 10)
|
|
|> helixRevolutions({
|
|
angleStart = 0,
|
|
ccw = true,
|
|
revolutions = 16
|
|
}, %)
|
|
```
|
|
|
|
|
|
|
|
|