modeling-app/docs/kcl/helix.md

title, excerpt, layout

title	excerpt	layout
helix	Create a helix.	manual

Create a helix.

helix(data: HelixData) -> HelixValue

Arguments

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

Returns

HelixValue - A helix.

Examples

<<<<<<< HEAD
// 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 }, %)
||||||| parent of 8845dda8f (KCL: Line and Extrude use kw args)
part001 = startSketchOn('XY')
  |> circle({ center = [5, 5], radius = 10 }, %)
  |> extrude(10, %)
  |> helix({
       angleStart = 0,
       ccw = true,
       revolutions = 16
     }, %)
=======
part001 = startSketchOn('XY')
  |> circle({ center = [5, 5], radius = 10 }, %)
  |> extrude(length = 10)
  |> helix({
       angleStart = 0,
       ccw = true,
       revolutions = 16
     }, %)
>>>>>>> 8845dda8f (KCL: Line and Extrude use kw args)

// Create a helix around an edge.
helper001 = startSketchOn('XZ')
  |> startProfileAt([0, 0], %)
  |> line([0, 10], %, $edge001)

helixPath = helix({
  angleStart = 0,
  ccw = true,
  revolutions = 16,
  length = 10,
  radius = 5,
  axis = edge001
})

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

// Create a helix around a custom axis.
helixPath = helix({
  angleStart = 0,
  ccw = true,
  revolutions = 16,
  length = 10,
  radius = 5,
  axis = {
    custom = {
      axis = [0, 0, 1.0],
      origin = [0, 0.25, 0]
    }
  }
})

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