kcl-std → functions → 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 EdgeAxis to use for the helix. The center of the helix's base will be at this axis's origin point.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; created by the helix function.

Examples

Rendered example of helix 0

Rendered example of helix 1

Rendered example of helix 2

Rendered example of helix 3

Found a typo?