Docs Home
/
KCL Standard Library
/
Functions
/
Std Helix

helixFunction in std

Create a helix.

Arguments

NameTypeDescriptionRequired
revolutionsnumber(_)Number of revolutions.Yes
angleStartnumber(Angle)Start angle.Yes
ccwboolIs the helix rotation counter clockwise? The default is false.No
radiusnumber(Length)Radius of the helix.No
axisAxis3d or Edge or Segment or anyAxis to use for the helix. Can be an Axis3d, an Edge, or a Segment when not using a cylinder. Experimental face API: edge reference objects (e.g. { sideFaces = [faceTag1, faceTag2] }) are not ready for generated or user-facing KCL yet; prefer Axis3d, Edge, or Segment until point-and-click and migration support ships.No
lengthnumber(Length)Length of the helix. This is not necessary if the helix is created around an edge. If not given the length of the edge is used.No
cylinderSolidCylinder to create the helix on.No

Returns

Helix - A helix.

Examples

Rendered example of helix 0

Rendered example of helix 1

Rendered example of helix 2

Rendered example of helix 3

Found a typo?