modeling-app/docs/kcl/helix.md

title, excerpt, layout

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

Create a helix on a cylinder.

helix(data: HelixData, solid: Solid) -> Solid

Arguments

Name	Type	Description	Required
data	HelixData	Data for helices.	Yes
solid	Solid	An solid is a collection of extrude surfaces.	Yes

Returns

Solid - An solid is a collection of extrude surfaces.

Examples

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