Part Helix: Difference between revisions
mNo edit summary |
(Marked this version for translation) |
||
(12 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{UnfinishedDocu{{#translation:}}}} |
|||
<translate> |
<translate> |
||
Line 24: | Line 23: | ||
<!--T:13--> |
<!--T:13--> |
||
A [[Image:Part_Helix.svg|24px]] '''Part Helix''' 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 axis of the helix matches the Z axis and its bottom point, the start point, lies on the X axis. |
|||
The [[Image:Part_Helix.svg|24px]] [[Part_Helix|Part Helix]] command creates a parametric helix shape. |
|||
</translate> |
|||
FreeCAD creates a helix, with default values for pitch, height and radius. The shape angle can be set too. |
|||
[[Image:Part_Helix_Example.png|400px]] |
|||
<translate> |
|||
By default, the box is positioned with the lower left corner at the origin (0,0,0). The bottom of the cube is on the xy-plane. Its extension in x, y and z direction follows the positive axis values. |
|||
[[File:Part Helix Example.png|Screenshot of Part Helix]] |
|||
== Usage == <!--T:4--> |
== Usage == <!--T:4--> |
||
<!--T: |
<!--T:20--> |
||
See [[Part_Primitives#Usage|Part Primitives]]. |
|||
# There are several ways to invoke the command: |
|||
#* Press the {{Button|[[Image:Part_Primitives.svg|16px]] [[Part Primitives|Create Primitives...]]}} button. |
|||
#* Select the {{MenuCommand|Part → Create Primitives → [[Image:Part_Primitives.svg|16px]] Create Primitives...}} option from the menu. |
|||
#* Select the {{MenuCommand|[[Image:Part_Helix.svg|16px]] Helix}} option from the menu. |
|||
# Set options and press {{Button|Create}}. |
|||
# To close the dialog press {{Button|Close}}. |
|||
== Example == |
== Example == <!--T:21--> |
||
<!--T:22--> |
|||
[[File:Part Helix Scripting Example.png|thumb|Part Box scripting example]] |
|||
[[Image:Part_Helix_Scripting_Example.png|thumb|Part Helix from the scripting example]] |
|||
<!--T:23--> |
|||
A Part Box object with the values of the bottom scripting example are shown here. |
|||
A Part Helix object created with the [[#Scripting|scripting example]] below is shown here. |
|||
== Notes == <!--T:6--> |
|||
<!--T:10--> |
|||
* A Part Helix can be used to create screw threads. See [[Thread_for_Screw_Tutorial|Thread for Screw Tutorial]]. |
|||
<!--T: |
== Properties == <!--T:24--> |
||
* {{Parameter|Pitch:}}The pitch corresponds to the space between two consecutive "turns" of the helix measured along the main axis of the helix. |
|||
* {{Parameter|Height:}} The height corresponds to the overall height of the helix measured along the main axis of the helix. |
|||
* {{Parameter|Radius:}} The radius corresponds to the radius of the circle built by the helix by viewing the helix from the top or bottom. |
|||
* {{Parameter|Angle}}: Per default the helix is built on a imaginary cylinder. With this option it is possible to build the helix on a imaginary cone. This angle corresponds to the angle of the cone. The value must be comprised between 0 and +90 deg. |
|||
* {{Parameter|Right-handed or Left-handed:}} This parameter specifies the [https://en.wikipedia.org/wiki/Screw_thread handedness] of the helix. |
|||
<!--T:25--> |
|||
See also: [[Property_editor|Property editor]]. |
|||
<!--T: |
<!--T:26--> |
||
A Part Helix object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
|||
* {{Parameter|X:}} The main axis of the helix will be translated along the x axis of the value you indicate in this field. |
|||
* {{Parameter|Y:}} The main axis of the helix will be translated along the y axis of the value you indicate in this field. |
|||
* {{Parameter|Z:}} The main axis of the helix will be translated along the z axis of the value you indicate in this field. |
|||
* {{Parameter|Direction:}} Per default the main axis of the helix is the z axis. Here you have the possibility to edit the main axis of the helix. If you select the parameter "user defined..." , you will be invited to indicate the main axis of the helix by entering the coordinates of its vector. |
|||
* {{Parameter|3D View:}} allows you select center in the 3D view |
|||
== |
=== Data === <!--T:27--> |
||
<!--T:28--> |
|||
{{TitleProperty|Attachment}} |
|||
Once you have created the helix you have the possibility to edit its parameters. |
|||
{| |
|||
| [[File:PartHelixProperty_en.png]] |
|||
| |
|||
The parameters in this menu are similar to those described above.<br /> |
|||
{{KEY|Base}}<br /> |
|||
* {{Parameter|Placement:}} allows you to move or rotate the helix |
|||
* {{Parameter|Angle:}} |
|||
|} |
|||
<!--T:29--> |
|||
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]]. |
|||
<!--T:30--> |
|||
== Properties == |
|||
{{TitleProperty|Coordinate System}} |
|||
<!--T:31--> |
|||
See also: [[Property_editor|Property editor]]. |
|||
* {{PropertyData|Local Coord|Enumeration}}: The [https://en.wikipedia.org/wiki/Screw_thread 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. |
|||
<!--T:32--> |
|||
A Part Box object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
|||
{{TitleProperty|Helix}} |
|||
<!--T:33--> |
|||
=== Data === |
|||
* {{PropertyData|Pitch|Length}}: The distance between two consecutive turns of the helix measured along its Z axis. The default is {{Value|1mm}}. |
|||
* {{PropertyData|Height|Length}}: The height of the helix. The default is {{Value|2mm}}. |
|||
* {{PropertyData|Radius|Length}}: The start radius of the helix. The helix has a constant radius if {{PropertyData|Angle}} is {{Value|0°}}. |
|||
* {{PropertyData|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. |
|||
* {{PropertyData|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 == <!--T:34--> |
|||
{{TitleProperty|Coordinate System}} |
|||
*{{PropertyData|Local Coord}}: The [https://en.wikipedia.org/wiki/Screw_thread handedness] of the helix. |
|||
{{TitleProperty|Helix}} |
|||
*{{PropertyData|Pitch|Length}}: The pitch corresponds to the space between two consecutive "turns" of the helix measured along the main axis of the helix. |
|||
*{{PropertyData|Height|Length}}: The height corresponds to the overall height of the helix measured along the main axis of the helix. |
|||
*{{PropertyData|Radius|Length}}: The radius corresponds to the radius of the circle built by the helix by viewing the helix from the top or bottom. |
|||
*{{PropertyData|Segment Length|Length}}: |
|||
*{{PropertyData|Angle|Angle}}: Per default the helix is built on a imaginary cylinder. With this option it is possible to build the helix on a imaginary cone. This angle corresponds to the angle of the cone. The value must be comprised between 0 and +90 deg. |
|||
<!--T:35--> |
|||
==Scripting== |
|||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
<!--T:36--> |
|||
A Part Helix is created with the {{Incode|addObject()}} method of the document. |
|||
A Part Helix can be created with the {{Incode|addObject()}} method of the document: |
|||
</translate> |
</translate> |
||
Line 110: | Line 93: | ||
<translate> |
<translate> |
||
<!--T:37--> |
|||
* Where {{Incode|myHelix}} is the name for the object. The name must be unique for the entire document. |
|||
* Where {{Incode|"myHelix"}} is the name for the object. |
|||
* The function returns the newly created object. |
* The function returns the newly created object. |
||
<!--T:38--> |
|||
The {{Incode|Label}} is the user editable name for the object. It can be easily changed by |
|||
Example: |
|||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
import FreeCAD as App |
|||
helix.Label = "new myHelixName" |
|||
}} |
|||
<translate> |
|||
doc = App.activeDocument() |
|||
You can access and modify attributes of the {{Incode|helix}} object. For example, you may wish to modify the pitch, height and radius parameters. |
|||
helix = doc.addObject("Part::Helix", "myHelix") |
|||
</translate> |
|||
{{Code|code= |
|||
helix.Pitch = 2 |
helix.Pitch = 2 |
||
helix.Height = 3 |
helix.Height = 3 |
||
Line 130: | Line 112: | ||
helix.SegmentLength = 21 |
helix.SegmentLength = 21 |
||
helix.Angle = 45 |
helix.Angle = 45 |
||
helix.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(75, 60, 30)) |
|||
}} |
|||
<translate> |
|||
doc.recompute() |
|||
You can change its placement and orientation with: |
|||
</translate> |
|||
{{Code|code= |
|||
helix.Placement = FreeCAD.Placement(FreeCAD.Vector(1, 2, 3), FreeCAD.Rotation(75, 60, 30)) |
|||
}} |
}} |
||
<translate> |
<translate> |
||
Line 153: | Line 130: | ||
</translate> |
</translate> |
||
{{ |
{{Part_Tools_navi{{#translation:}}}} |
||
{{Userdocnavi{{#translation:}}}} |
{{Userdocnavi{{#translation:}}}} |
Latest revision as of 10:17, 3 March 2022
Part Helix |
Menu location |
---|
Part → Create primitives → Helix |
Workbenches |
Part, OpenSCAD |
Default shortcut |
None |
Introduced in version |
- |
See also |
Part Primitives |
Description
A Part Helix is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement 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.
Notes
- A Part Helix can be used to create screw threads. See Thread for Screw Tutorial.
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
Attachment
The object has the same attachment properties as a Part Part2DObject.
Coordinate System
- DataLocal Coord (
Enumeration
): The handedness, or direction, of the helix:Right-handed
orLeft-handed
. The default isRight-handed
, meaning the helix turns counterclockwise as it goes up.
Helix
- DataPitch (
Length
): The distance between two consecutive turns of the helix measured along its Z axis. The default is1mm
. - DataHeight (
Length
): The height of the helix. The default is2mm
. - DataRadius (
Length
): The start radius of the helix. The helix has a constant radius if DataAngle is0°
. - DataSegment Length (
QuantityConstraint
): The number of turns per helix subdivision. The default is1
, meaning each full turn of the helix is a separate segment. Use0
to suppress subdivision. - DataAngle (
Angle
): The angle that defines of the outer shape of the helix. Valid range:-90° < value < 90°
. The default is0°
. If it is0°
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 addObject()
method of the document:
helix = FreeCAD.ActiveDocument.addObject("Part::Helix", "myHelix")
- Where
"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()
- 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