kcl →

helix

Create a helix.

helix(data: HelixData) -> HelixValue

Arguments

Name	Type	Description	Required
`data`	`HelixData`	Data for a helix.	Yes

Returns

HelixValue - A helix.

Examples

// Create a helix around the Z axis.
helixPath = helix({
  angleStart = 0,
  ccw = true,
  revolutions = 16,
  length = 10,
  radius = 5,
  axis = 'Z'
})

// Create a spring by sweeping around the helix path.
springSketch = startSketchOn('YZ')
  |> circle({ center = [0, 0], radius = 1 }, %)
// |> sweep({ path = helixPath }, %)

Rendered example of helix 0

Rendered example of helix 1