Skip to content

Latest commit

 

History

History
103 lines (56 loc) · 3.35 KB

Part_Helix.md

File metadata and controls

103 lines (56 loc) · 3.35 KB
GuiCommand
Name MenuLocation Workbenches SeeAlso
Part Helix
Part , Part_Primitives , Helix
Part_Workbench, OpenSCAD_Workbench
Part_Primitives

Part Helix

Description

A Part Helix is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its Placement 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

Part Helix from the scripting example

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

Notes

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

{{TitleProperty|Attachment}}

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

{{TitleProperty|Coordinate System}}

  • Local Coord|Enumeration: The handedness, or direction, of the helix: {{Value|Right-handed}} or {{Value|Left-handed}}. The default is {{Value|Right-handed}}, meaning the helix turns counterclockwise as it goes up.

{{TitleProperty|Helix}}

  • Pitch|Length: The distance between two consecutive turns of the helix measured along its Z axis. The default is {{Value|1mm}}.

  • Height|Length: The height of the helix. The default is {{Value|2mm}}.

  • Radius|Length: The start radius of the helix. The helix has a constant radius if Angle is {{Value|0°}}.

  • Segment Length|QuantityConstraint: The number of turns per helix subdivision. The default is {{Value|1}}, meaning each full turn of the helix is a separate segment. Use {{Value|0}} to suppress subdivision.

  • Angle|Angle: The angle that defines of the outer shape of the helix. Valid range: {{Value|-90° < value < 90°}}. The default is {{Value|0°}}. If it is {{Value|0°}} 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 {{Incode|addObject()}} method of the document:

helix = FreeCAD.ActiveDocument.addObject("Part::Helix", "myHelix")
  • Where {{Incode|"myHelix"}} is the name for the object.
  • The function returns the newly created object.

Example:

import FreeCAD as App

doc = App.activeDocument()

helix = doc.addObject("Part::Helix", "myHelix")
helix.Pitch = 2
helix.Height = 3
helix.Radius = 4
helix.SegmentLength = 21
helix.Angle = 45
helix.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(75, 60, 30))

doc.recompute()

{{Part_Tools_navi}}


documentation index > Part > Part Helix