Files
modeling-app/docs/kcl/helix.md
Jess Frazelle 9a437ca973 Updates path docs for website (#4019)
* fix docs paths for website

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix docs paths for website

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
2024-09-27 14:26:53 -07:00

164 KiB

title, excerpt, layout
title excerpt layout
helix Create a helix on a cylinder. manual

Create a helix on a cylinder.

helix(data: HelixData, extrude_group: ExtrudeGroup) -> ExtrudeGroup

Arguments

Name Type Description Required
data HelixData Data for helices. Yes
extrude_group ExtrudeGroup An extrude group is a collection of extrude surfaces. Yes

Returns

ExtrudeGroup - An extrude group is a collection of extrude surfaces.

Examples

const part001 = startSketchOn('XY')
  |> circle({ center: [5, 5], radius: 10 }, %)
  |> extrude(10, %)
  |> helix({
       angleStart: 0,
       ccw: true,
       revolutions: 16
     }, %)

Rendered example of helix 0