Part Spiral/en: Difference between revisions
(Importing a new version from external source) |
(Updating to match new version of source page) |
||
(13 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
⚫ | |||
{{GuiCommand|Name=Part Spiral|MenuLocation=[[Part_Module|Part]] → [[Part_CreatePrimitives|Create Primitives]] → Spiral|Workbenches=[[Part Module|Part]], [[OpenSCAD_Module|OpenSCAD]]|SeeAlso=[[Part_CreatePrimitives|Create Primitives]]}} |
|||
{{Docnav |
|||
|[[Part_Helix|Helix]] |
|||
|[[Part_Circle|Circle]] |
|||
|[[Part_Workbench|Part]] |
|||
|IconL=Part_Helix.svg |
|||
|IconR=Part_Circle.svg |
|||
|IconC=Workbench_Part.svg |
|||
}} |
|||
{{GuiCommand |
|||
|Name=Part Spiral |
|||
|MenuLocation=Part → [[Part_Primitives|Create primitives]] → Spiral |
|||
|Workbenches=[[Part_Workbench|Part]], [[OpenSCAD_Workbench|OpenSCAD]] |
|||
⚫ | |||
|SeeAlso=[[Part_Primitives|Part Primitives]] |
|||
}} |
|||
== Description == |
== Description == |
||
A Spiral geometric primitive is available from the Create Primitives dialogue in the Part workbench. |
|||
A [[Image:Part_Spiral.svg|24px]] '''Part Spiral''' is a parametric shape that can be created with the [[Image:Part_Primitives.svg|24px]] [[Part_Primitives|Part Primitives]] command. In the coordinate system defined by its {{PropertyData|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. |
|||
The Create Primitives dialogue can be accessed via the [[Part_CreatePrimitives|CreatePrimitives]] icon [[Image:Part_CreatePrimitives.png|32px]] located in the Part menu or the Part toolbar, in the Part Workbench. |
|||
[[Image:Part_Spiral_Example.png|400px]] |
|||
== Usage == |
|||
[[File:SpiralDefault_it.png]] |
|||
See [[Part_Primitives#Usage|Part Primitives]]. |
|||
[[File:Spiral_x45_it.png]] |
|||
== Example == |
|||
[[File:Spiral_y45_it.png]] |
|||
[[Image:Part_Spiral_Scripting_Example.png|thumb|Part Spiral from the scripting example]] |
|||
A Part Spiral object created with the [[#Scripting|scripting example]] below is shown here. |
|||
⚫ | |||
== Properties == |
|||
See also: [[Property_editor|Property editor]]. |
|||
{{clear}} |
|||
⚫ | |||
A Part Spiral object is derived from a [[Part_Feature|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#Data|Part Part2DObject]]. |
|||
{{TitleProperty|Spiral}} |
|||
* {{PropertyData|Growth|Length}}: The distance between two consecutive turns of the spiral. The default is {{Value|1mm}}. |
|||
* {{PropertyData|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}}. |
|||
* {{PropertyData|Rotations|QuantityConstraint}}: The number of rotations, or turns, of the spiral. The default is {{Value|2}}. |
|||
* {{PropertyData|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. |
|||
== Scripting == |
|||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
A Part Spiral can be created with the {{Incode|addObject()}} method of the document: |
|||
{{Code|code= |
|||
spiral = FreeCAD.ActiveDocument.addObject("Part::Spiral", "mySpiral") |
|||
}} |
|||
* Where {{Incode|"mySpiral"}} is the name for the object. |
|||
* The function returns the newly created object. |
|||
Example: |
|||
{{Code|code= |
|||
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() |
|||
}} |
|||
{{Docnav |
|||
|[[Part_Helix|Helix]] |
|||
|[[Part_Circle|Circle]] |
|||
|[[Part_Workbench|Part]] |
|||
|IconL=Part_Helix.svg |
|||
|IconR=Part_Circle.svg |
|||
|IconC=Workbench_Part.svg |
|||
}} |
|||
{{Part_Tools_navi{{#translation:}}}} |
|||
{{Userdocnavi{{#translation:}}}} |
Latest revision as of 10:20, 3 March 2022
Part Spiral |
Menu location |
---|
Part → Create primitives → Spiral |
Workbenches |
Part, OpenSCAD |
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
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.
A Part Spiral can be created with the addObject()
method of the document:
spiral = FreeCAD.ActiveDocument.addObject("Part::Spiral", "mySpiral")
- Where
"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()
- 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