Part Cylinder: Difference between revisions
(Usage, Example, Notes.) |
(typo) |
||
(12 intermediate revisions by the same user not shown) | |||
Line 25: | Line 25: | ||
The [[Image:Part_Cylinder.svg|24px]] '''Part Cylinder''' command creates a parametric cylinder solid. It is the result of extruding a circular arc along a straight path. In the coordinate system defined by its {{PropertyData|Placement}} property, the bottom face of the cylinder lies on the XY plane with its center at the origin. |
The [[Image:Part_Cylinder.svg|24px]] '''Part Cylinder''' command creates a parametric cylinder solid. It is the result of extruding a circular arc along a straight path. In the coordinate system defined by its {{PropertyData|Placement}} property, the bottom face of the cylinder lies on the XY plane with its center at the origin. |
||
<!--T:25--> |
|||
A Part Cylinder can be turned into a segment of a cylinder by changing its {{PropertyData|Angle}} property. |
A Part Cylinder can be turned into a segment of a cylinder by changing its {{PropertyData|Angle}} property. |
||
Line 34: | Line 35: | ||
<!--T:17--> |
<!--T:17--> |
||
# There are several ways to invoke the command: |
# There are several ways to invoke the command: |
||
#* Press the {{Button|[[Image:Part_Cylinder.svg|16px]] [[ |
#* Press the {{Button|[[Image:Part_Cylinder.svg|16px]] [[Part_Cylinder|Part Cylinder]]}} button. |
||
#* Select the {{MenuCommand|Part → Primitives → [[Image:Part_Cylinder.svg|16px]] Cylinder}} option from the menu. |
#* Select the {{MenuCommand|Part → Primitives → [[Image:Part_Cylinder.svg|16px]] Cylinder}} option from the menu. |
||
# |
# The cylinder is created. |
||
# Optionally change the dimensions and {{PropertyData|Placement}} of the cylinder by doing one |
# Optionally change the dimensions and {{PropertyData|Placement}} of the cylinder by doing one of the following: |
||
#* Double-click the object in the [[Tree_view|Tree view]]: |
#* Double-click the object in the [[Tree_view|Tree view]]: |
||
#*# The {{MenuCommand| |
#*# The {{MenuCommand|Geometric Primitives}} task panel opens. |
||
#*# Change |
#*# Change one or more properties. |
||
#*# The object |
#*# The object is dynamically updated in the [[3D_view|3D view]]. |
||
#*# Press the {{Button|OK}} button. |
#*# Press the {{Button|OK}} button. |
||
#* Change the properties in the [[Property_editor|Property editor]]. |
#* 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. |
#* Change the {{PropertyData|Placement}} with the [[Image:Std_TransformManip.svg|16px]] [[Std_TransformManip|Std TransformManip]] command. |
||
== Example == |
== Example == <!--T:26--> |
||
<!--T:27--> |
|||
[[Image:Part_Cylinder_Scripting_Example.png|thumb|Part Cylinder scripting example |
[[Image:Part_Cylinder_Scripting_Example.png|thumb|Part Cylinder from the scripting example]] |
||
<!--T:28--> |
|||
A Part Cylinder object created with the [[#Scripting|scripting example]] below is shown here. |
A Part Cylinder object created with the [[#Scripting|scripting example]] below is shown here. |
||
== Notes == |
== Notes == <!--T:29--> |
||
<!--T:30--> |
|||
* A Part Cylinder 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 |
* A Part Cylinder 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. |
||
== Properties == <!--T:11--> |
== Properties == <!--T:11--> |
||
<!--T:31--> |
|||
See also: [[Property_editor|Property editor]]. |
See also: [[Property_editor|Property editor]]. |
||
<!--T:32--> |
|||
A Part Cylinder object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
A Part Cylinder object is derived from a [[Part_Feature|Part Feature]] object and inherits all its properties. It also has the following additional properties: |
||
=== Data === |
=== Data === <!--T:33--> |
||
<!--T:34--> |
|||
{{TitleProperty|Attachment}} |
{{TitleProperty|Attachment}} |
||
<!--T:35--> |
|||
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]]. |
The object has the same attachment properties as a [[Part_Part2DObject#Data|Part Part2DObject]]. |
||
<!--T:36--> |
|||
{{TitleProperty|Cylinder}} |
{{TitleProperty|Cylinder}} |
||
Line 76: | Line 85: | ||
* {{PropertyData|Angle|Angle}}: The angle of the circular arc that defines the cylinder. 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 cylinder. |
* {{PropertyData|Angle|Angle}}: The angle of the circular arc that defines the cylinder. 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 cylinder. |
||
<!--T:37--> |
|||
{{TitleProperty|Prism}} |
{{TitleProperty|Prism}} |
||
<!--T:38--> |
|||
* {{PropertyData|First Angle|Angle}}: The angle between the extrusion direction of the cylinder and its positive Z axis, measured around its Y axis. The angle is positive towards its positive X axis. Valid range: {{Value|0° <= value < 90°}}. The default is {{Value|0°}}. {{Version|0.20}} |
* {{PropertyData|First Angle|Angle}}: The angle between the extrusion direction of the cylinder and its positive Z axis, measured around its Y axis. The angle is positive towards its positive X axis. Valid range: {{Value|0° <= value < 90°}}. The default is {{Value|0°}}. {{Version|0.20}} |
||
* {{PropertyData|Second Angle|Angle}}: The angle between the extrusion direction of the cylinder and its positive Z axis, measured around its X axis. The angle is positive towards its positive Y axis. Valid range: {{Value|0° <= value < 90°}}. The default is {{Value|0°}}. {{Version|0.20}} |
* {{PropertyData|Second Angle|Angle}}: The angle between the extrusion direction of the cylinder and its positive Z axis, measured around its X axis. The angle is positive towards its positive Y axis. Valid range: {{Value|0° <= value < 90°}}. The default is {{Value|0°}}. {{Version|0.20}} |
||
== Scripting == <!--T:22--> |
== Scripting == <!--T:22--> |
||
<!--T:39--> |
|||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
<!--T:23--> |
<!--T:23--> |
||
A Part Cylinder can be created |
A Part Cylinder can be created with the {{Incode|addObject()}} method of the document: |
||
</translate> |
</translate> |
||
Line 93: | Line 107: | ||
<!--T:24--> |
<!--T:24--> |
||
* Where {{Incode|myCylinder}} is the |
* Where {{Incode|"myCylinder"}} is the name for the object. |
||
* The function returns the newly created object. |
* The function returns the newly created object. |
||
<!--T:40--> |
|||
The label text of the object can be easily changed by |
|||
Example: |
|||
</translate> |
</translate> |
||
{{Code|code= |
{{Code|code= |
||
import FreeCAD as App |
|||
cylinder.Label = "new myCylinderName" |
|||
}} |
|||
<translate> |
|||
doc = App.activeDocument() |
|||
You can change its placement and orientation with: |
|||
cylinder = doc.addObject("Part::Cylinder", "myCylinder") |
|||
</translate> |
|||
cylinder.Radius = 10 |
|||
{{Code|code= |
|||
cylinder.Height = 50 |
|||
cylinder.Placement = |
cylinder.Placement = App.Placement(App.Vector(5, 10, 15), App.Rotation(75, 60, 30)) |
||
doc.recompute() |
|||
}} |
}} |
||
<translate> |
<translate> |
||
<!--T:14--> |
<!--T:14--> |
||
Line 123: | Line 140: | ||
</translate> |
</translate> |
||
{{ |
{{Part_Tools_navi{{#translation:}}}} |
||
{{Userdocnavi{{#translation:}}}} |
{{Userdocnavi{{#translation:}}}} |
Latest revision as of 08:54, 4 March 2022
Part Cylinder |
Menu location |
---|
Part → Primitives → Cylinder |
Workbenches |
Part |
Default shortcut |
None |
Introduced in version |
- |
See also |
Part Primitives |
Description
The Part Cylinder command creates a parametric cylinder solid. It is the result of extruding a circular arc along a straight path. In the coordinate system defined by its DataPlacement property, the bottom face of the cylinder lies on the XY plane with its center at the origin.
A Part Cylinder can be turned into a segment of a cylinder by changing its DataAngle property.
Usage
- There are several ways to invoke the command:
- Press the Part Cylinder button.
- Select the Part → Primitives → Cylinder option from the menu.
- The cylinder is created.
- Optionally change the dimensions and DataPlacement of the cylinder 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 Cylinder object created with the scripting example below is shown here.
Notes
- A Part Cylinder 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 Cylinder 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.
Cylinder
- DataRadius (
Length
): The radius of the circular arc that defines the cylinder. The default is2mm
. - DataHeight (
Length
): The height of the cylinder. The default is10mm
. - DataAngle (
Angle
): The angle of the circular arc that defines the cylinder. Valid range:0° < value <= 360°
. The default is360°
. If it is smaller than360°
the resulting solid will be a segment of a cylinder.
Prism
- DataFirst Angle (
Angle
): The angle between the extrusion direction of the cylinder and its positive Z axis, measured around its Y axis. The angle is positive towards its positive X axis. Valid range:0° <= value < 90°
. The default is0°
. introduced in version 0.20 - DataSecond Angle (
Angle
): The angle between the extrusion direction of the cylinder and its positive Z axis, measured around its X axis. The angle is positive towards its positive Y axis. Valid range:0° <= value < 90°
. The default is0°
. introduced in version 0.20
Scripting
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.
A Part Cylinder can be created with the addObject()
method of the document:
cylinder = FreeCAD.ActiveDocument.addObject("Part::Cylinder", "myCylinder")
- Where
"myCylinder"
is the name for the object. - The function returns the newly created object.
Example:
import FreeCAD as App
doc = App.activeDocument()
cylinder = doc.addObject("Part::Cylinder", "myCylinder")
cylinder.Radius = 10
cylinder.Height = 50
cylinder.Placement = App.Placement(App.Vector(5, 10, 15), 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