Part Torus: Difference between revisions
(Changed Docnav to match Part_Module page order.) |
(typo) |
||
(43 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
<translate> |
<translate> |
||
<!--T:17--> |
<!--T:17--> |
||
{{Docnav |
{{Docnav |
||
|[[Part_Cone|Cone]] |
|[[Part_Cone|Cone]] |
||
|[[Part_Tube|Tube]] |
|[[Part_Tube|Tube]] |
||
|[[ |
|[[Part_Workbench|Part]] |
||
|IconL=Part_Cone.svg |
|IconL=Part_Cone.svg |
||
|IconR=Part_Tube.svg |
|IconR=Part_Tube.svg |
||
Line 14: | Line 15: | ||
{{GuiCommand |
{{GuiCommand |
||
|Name=Part Torus |
|Name=Part Torus |
||
|MenuLocation=Part → Torus |
|MenuLocation=Part → Primitives → Torus |
||
|Workbenches=[[ |
|Workbenches=[[Part_Workbench|Part]] |
||
|SeeAlso=[[ |
|SeeAlso=[[Part_Primitives|Part Primitives]] |
||
}} |
}} |
||
== Description == <!--T: |
== Description == <!--T:22--> |
||
Creates a simple parametric torus, with position, angle1, angle2, angle3, radius1 and radius2 as parameters. |
|||
⚫ | |||
The [[Image:Part_Torus.svg|24px]] '''Part Torus''' command creates a parametric torus solid, a doughnut shape. It is the result of sweeping a circular profile around a circular path. In the coordinate system defined by its {{PropertyData|Placement}} property, the circular path of the torus lies on the XY plane with its center at the origin. |
|||
<!--T:26--> |
|||
A Part Torus can be turned into a segment of a torus by changing its {{PropertyData|Angle3}} property. By changing its {{PropertyData|Angle1}} and/or {{PropertyData|Angle2}} properties the swept profile can become a segment of a circle. |
|||
</translate> |
</translate> |
||
[[ |
[[Image:Part_Torus_Example.png|400px]] |
||
<translate> |
<translate> |
||
==Usage== <!--T:4--> |
== Usage == <!--T:4--> |
||
<!--T:5--> |
<!--T:5--> |
||
# There are several ways to invoke the command: |
|||
# Switch to the [[Image:Workbench_Part.svg|24px]] [[Part Workbench|Part]] workbench. |
|||
#* Press the {{Button|[[Image:Part_Torus.svg|16px]] [[Part_Torus|Part Torus]]}} button. |
|||
# Invoke the Part Torus command several ways: |
|||
#* |
#* Select the {{MenuCommand|Part → Primitives → [[Image:Part_Torus.svg|16px]] Torus}} option from the menu. |
||
# The torus is created. |
|||
#* Use the {{MenuCommand|Part → Torus}} entry in the top menu. |
|||
# Optionally change the dimensions and {{PropertyData|Placement}} of the torus by doing one of the following: |
|||
#* Double-click the object in the [[Tree_view|Tree view]]: |
|||
#*# The {{MenuCommand|Geometric Primitives}} task panel opens. |
|||
#*# Change one or more properties. |
|||
#*# The object is dynamically updated in the [[3D_view|3D view]]. |
|||
#*# Press the {{Button|OK}} button. |
|||
#* Change the properties in the [[Property_editor|Property editor]]. |
|||
#* Change the {{PropertyData|Placement}} with the [[Image:Std_TransformManip.svg|16px]] [[Std_TransformManip|Std TransformManip]] command. |
|||
<!--T: |
== Example == <!--T:27--> |
||
'''Result:''' The torus will be positioned at origin (point 0,0,0) on creation.<br /> |
|||
The angle parameters (angle1, angle2, angle3), as well as the radius parameter (radius1 , radius2) parameters permit to parametrize the torus, see next section. |
|||
<!--T:28--> |
|||
[[Image:Part_Torus_Scripting_Example.png|thumb|Part Torus from the scripting example]] |
|||
<!--T: |
<!--T:29--> |
||
A Part Torus object created with the [[#Scripting|scripting example]] below is shown here. |
|||
[[File:TorusExampleOverviewParameters.jpg]] |
|||
<!--T: |
== Notes == <!--T:30--> |
||
'''Parameter''' |
|||
<!--T: |
<!--T:31--> |
||
* A Part Torus can also be created with the [[Image:Part_Primitives.svg|16px]] [[Part_Primitives|Part Primitives]] command. With that command you can specify the dimensions and placement at creation time. |
|||
A torus can be assimilated to a small disc that makes a circular orbit around an imaginary axe. Thus the parametric torus is defined by the following parameters: |
|||
== Properties == <!--T:11--> |
|||
<!--T:32--> |
|||
See also: [[Property_editor|Property editor]]. |
|||
<!--T:33--> |
|||
A Part Torus object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
|||
=== Data === <!--T:34--> |
|||
<!--T:35--> |
|||
{{TitleProperty|Attachment}} |
|||
<!--T:36--> |
|||
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]]. |
|||
<!--T:37--> |
|||
{{TitleProperty|Torus}} |
|||
<!--T:9--> |
<!--T:9--> |
||
* {{ |
* {{PropertyData|Radius1|Length}}: The radius of the circular path of the torus. The default is {{Value|10mm}}. |
||
* {{ |
* {{PropertyData|Radius2|Length}}: The radius of the circular profile of the torus. The default is {{Value|2mm}}. |
||
* {{PropertyData|Angle1|Angle}}: The start angle of the circular profile. Valid range: {{Value|-180° <= value <= 180°}}. The default is {{Value|-180°}}. |
|||
* {{Parameter|Angle1:}} 1st angle to cut / define the disc of the torus |
|||
* {{PropertyData|Angle2|Angle}}: The end angle the circular profile. Valid range: {{Value|-180° <= value <= 180°}}. The default is {{Value|180°}}. If the total angle of the circular profile is smaller than {{Value|360°}} the profile will have a pie-shape. |
|||
* {{Parameter|Angle2:}} 2nd angle to cut / define the disc of the torus |
|||
* {{PropertyData|Angle3|Angle}}: The angle of the circular path of the torus. Valid range: {{Value|0° < value <= 360°}}. The default is {{Value|360°}}. If it is smaller than {{Value|360°}} the resulting solid will be a segment of a torus. |
|||
* {{Parameter|Angle3:}} 3rd angle to define the circumference of the torus. |
|||
<!--T: |
== Scripting == <!--T:23--> |
||
as well as the standard set of placement parameters. The pictures below give a visual overview of the parameters antecedently mentioned: |
|||
<!--T: |
<!--T:38--> |
||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
[[File:TorusExampleRadius1.jpg]] |
|||
The parameter Radius1 has a value of 20 mm. |
|||
<!--T: |
<!--T:24--> |
||
A Part Torus can be created with the {{Incode|addObject()}} method of the document: |
|||
[[File:TorusExampleRadius2.jpg]] |
|||
The parameter Radius2 has a value of 2 mm. |
|||
</translate> |
|||
⚫ | |||
{{Code|code= |
|||
[[File:TorusExampleAngle1.jpg]] |
|||
torus = FreeCAD.ActiveDocument.addObject("Part::Torus", "myTorus") |
|||
The parameter Angle1 has a value of -90°. Notice that, the "angle measure" tool cannot display negative angle. Considered the displayed value in picture as "-90°". |
|||
}} |
|||
<translate> |
|||
<!--T: |
<!--T:25--> |
||
* Where {{Incode|"myTorus"}} is the name for the object. |
|||
[[File:TorusExampleAngle2.jpg]] |
|||
* The function returns the newly created object. |
|||
The parameter Angle2 has a value of 90°. |
|||
<!--T: |
<!--T:39--> |
||
Example: |
|||
[[File:TorusExampleAngle3.jpg]] |
|||
The parameter Angle3 has a value of 90°. |
|||
</translate> |
|||
{{clear}} |
|||
{{Code|code= |
|||
import FreeCAD as App |
|||
doc = App.activeDocument() |
|||
torus = doc.addObject("Part::Torus", "myTorus") |
|||
torus.Radius1 = 20 |
|||
torus.Radius2 = 10 |
|||
torus.Angle1 = -90 |
|||
torus.Angle2 = 45 |
|||
torus.Angle3 = 270 |
|||
torus.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(30, 45, 10)) |
|||
doc.recompute() |
|||
}} |
|||
<translate> |
|||
Line 85: | Line 131: | ||
|[[Part_Cone|Cone]] |
|[[Part_Cone|Cone]] |
||
|[[Part_Tube|Tube]] |
|[[Part_Tube|Tube]] |
||
|[[ |
|[[Part_Workbench|Part]] |
||
|IconL=Part_Cone.svg |
|IconL=Part_Cone.svg |
||
|IconR=Part_Tube.svg |
|IconR=Part_Tube.svg |
||
Line 92: | Line 138: | ||
</translate> |
</translate> |
||
{{ |
{{Part_Tools_navi{{#translation:}}}} |
||
{{Userdocnavi{{#translation:}}}} |
{{Userdocnavi{{#translation:}}}} |
Latest revision as of 08:56, 4 March 2022
Part Torus |
Menu location |
---|
Part → Primitives → Torus |
Workbenches |
Part |
Default shortcut |
None |
Introduced in version |
- |
See also |
Part Primitives |
Description
The Part Torus command creates a parametric torus solid, a doughnut shape. It is the result of sweeping a circular profile around a circular path. In the coordinate system defined by its DataPlacement property, the circular path of the torus lies on the XY plane with its center at the origin.
A Part Torus can be turned into a segment of a torus by changing its DataAngle3 property. By changing its DataAngle1 and/or DataAngle2 properties the swept profile can become a segment of a circle.
Usage
- There are several ways to invoke the command:
- Press the Part Torus button.
- Select the Part → Primitives → Torus option from the menu.
- The torus is created.
- Optionally change the dimensions and DataPlacement of the torus by doing one of the following:
- Double-click the object in the Tree view:
- The Geometric Primitives task panel opens.
- Change one or more properties.
- The object is dynamically updated in the 3D view.
- Press the OK button.
- Change the properties in the Property editor.
- Change the DataPlacement with the Std TransformManip command.
- Double-click the object in the Tree view:
Example
A Part Torus object created with the scripting example below is shown here.
Notes
- A Part Torus can also be created with the Part Primitives command. With that command you can specify the dimensions and placement at creation time.
Properties
See also: Property editor.
A Part Torus 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.
Torus
- DataRadius1 (
Length
): The radius of the circular path of the torus. The default is10mm
. - DataRadius2 (
Length
): The radius of the circular profile of the torus. The default is2mm
. - DataAngle1 (
Angle
): The start angle of the circular profile. Valid range:-180° <= value <= 180°
. The default is-180°
. - DataAngle2 (
Angle
): The end angle the circular profile. Valid range:-180° <= value <= 180°
. The default is180°
. If the total angle of the circular profile is smaller than360°
the profile will have a pie-shape. - DataAngle3 (
Angle
): The angle of the circular path of the torus. Valid range:0° < value <= 360°
. The default is360°
. If it is smaller than360°
the resulting solid will be a segment of a torus.
Scripting
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.
A Part Torus can be created with the addObject()
method of the document:
torus = FreeCAD.ActiveDocument.addObject("Part::Torus", "myTorus")
- Where
"myTorus"
is the name for the object. - The function returns the newly created object.
Example:
import FreeCAD as App
doc = App.activeDocument()
torus = doc.addObject("Part::Torus", "myTorus")
torus.Radius1 = 20
torus.Radius2 = 10
torus.Angle1 = -90
torus.Angle2 = 45
torus.Angle3 = 270
torus.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(30, 45, 10))
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, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub