| GuiCommand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
A 
Part Spiral is a parametric shape that can be created with the 
Part Primitives command. In the coordinate system defined by its Placement property, the spiral lies on the XY plane with its center at the origin and its start point on the X axis. It widens as it turns counterclockwise.
See Part Primitives.
A Part Spiral object created with the scripting example below is shown here.
See also: Property editor.
A Part Spiral object is derived from a Part Feature object and inherits all its properties. It also has the following additional properties:
{{TitleProperty|Attachment}}
The object has the same attachment properties as a Part Part2DObject.
{{TitleProperty|Spiral}}
-
Growth|Length: The distance between two consecutive turns of the spiral. The default is {{Value|1mm}}.
-
Radius|Length: The start radius of the spiral, the distance between its center and its start point. Can be {{Value|0mm}}. The default is {{Value|1mm}}.
-
Rotations|QuantityConstraint: The number of rotations, or turns, of the spiral. The default is {{Value|2}}.
-
Segment Length|QuantityConstraint: The number of turns per spiral subdivision. The default is {{Value|1}}, meaning each full turn of the spiral is a separate segment. Use {{Value|0}} to suppress subdivision.
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.
A Part Spiral can be created with the {{Incode|addObject()}} method of the document:
spiral = FreeCAD.ActiveDocument.addObject("Part::Spiral", "mySpiral")- Where {{Incode|"mySpiral"}} is the name for the object.
- The function returns the newly created object.
Example:
import FreeCAD as App
doc = App.activeDocument()
spiral = doc.addObject("Part::Spiral", "mySpiral")
spiral.Growth = 2
spiral.Radius = 3
spiral.Rotations = 4
spiral.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(75, 60, 30))
doc.recompute(){{Part_Tools_navi}}
⏵ documentation index > Part > Part Spiral