Part Helix/pl

Description
A Part Helix is a parametric shape that can be created with the  Part Primitives command. In the coordinate system defined by its property, the axis of the helix matches the Z axis and its bottom point, the start point, lies on the X axis.



Usage
See Part Primitives.

Example


A Part Helix object created with the scripting example below is shown here.

Properties
See also: Property editor.

A Part Helix object is derived from a Part Feature object and inherits all its properties. It also has the following additional properties:

Data
The object has the same attachment properties as a Part Part2DObject.


 * : The handedness, or direction, of the helix: or . The default is, meaning the helix turns counterclockwise as it goes up.


 * : The distance between two consecutive turns of the helix measured along its Z axis. The default is.
 * : The height of the helix. The default is.
 * : The start radius of the helix. The helix has a constant radius if is.
 * : The number of turns per helix subdivision. The default is, meaning each full turn of the helix is a separate segment. Use to suppress subdivision.
 * : The angle that defines of the outer shape of the helix. Valid range: . The default is . If it is the helix is cylindrical, else it is conical.

Scripting
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.

A Part Helix can be created with the method of the document:


 * Where is the name for the object.
 * The function returns the newly created object.

Example: