Part Spiral
This documentation is not finished. Please help and contribute documentation.
GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.
See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.
Part Spiral |
Menu location |
---|
Part → Create primitives → Spiral |
Workbenches |
Part |
Default shortcut |
None |
Introduced in version |
0.14 |
See also |
Part Primitives |
Description
A Part Spiral is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement 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.
Usage
See Part Primitives.
Example
A Part Spiral object created with the scripting example below is shown here.
Properties
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:
Data
Attachment
The object has the same attachment properties as a Part Part2DObject.
Spiral
- DataGrowth (
Length
): The distance between two consecutive turns of the spiral. The default is1mm
. - DataRadius (
Length
): The start radius of the spiral, the distance between its center and its start point. Can be0mm
. The default is1mm
. - DataRotations (
QuantityConstraint
): The number of rotations, or turns, of the spiral. The default is2
. - DataSegment Length (
QuantityConstraint
): The number of turns per spiral subdivision. The default is1
, meaning each full turn of the spiral is a separate segment. Use0
to suppress subdivision.
Scripting
A Part Spiral is created with the addObject()
method of the document.
spiral = FreeCAD.ActiveDocument.addObject("Part::Spiral", "mySpiral")
- Where
mySpiral
is the name for the object. The name must be unique for the entire document. - The function returns the newly created object.
The Label
is the user editable name for the object. It can be easily changed by
spiral.Label = "new mySpiralName"
You can access and modify attributes of the spiral
object. For example, you may wish to modify the growth, radius and rotations parameters.
spiral.Growth = 2
spiral.Radius = 3
spiral.Rotations = 4
You can change its placement and orientation with:
spiral.Placement = FreeCAD.Placement(FreeCAD.Vector(1, 2, 3), FreeCAD.Rotation(75, 60, 30))
- Primitives: Box, Cylinder, Sphere, Cone, Torus, Tube, Create primitives, Shape builder
- Creation and modification: Extrude, Revolve, Mirror, Fillet, Chamfer, Make face from wires, Ruled Surface, Loft, Sweep, Section, Cross sections, 3D Offset, 2D Offset, Thickness, Projection on surface, Attachment
- Boolean: Make compound, Explode Compound, Compound Filter, Boolean, Cut, Fuse, Common, Connect, Embed, Cutout, Boolean fragments, Slice apart, Slice, XOR
- Measure: Measure Linear, Measure Angular, Measure Refresh, Clear All, Toggle All, Toggle 3D, Toggle Delta
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub