Part RegularPolygon/en: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
{{UnfinishedDocu{{#translation:}}}} <!-- Note: Screenshot + Formatted Parameters + Scripting section. --> |
|||
{{Docnav |
{{Docnav |
||
Line 13: | Line 12: | ||
{{GuiCommand |
{{GuiCommand |
||
|Name=Part RegularPolygon |
|Name=Part RegularPolygon |
||
|MenuLocation=Part → [[Part_Primitives|Create primitives]] → Regular |
|MenuLocation=Part → [[Part_Primitives|Create primitives]] → Regular polygon |
||
|Workbenches=[[Part_Workbench|Part]] |
|Workbenches=[[Part_Workbench|Part]], [[OpenSCAD_Workbench|OpenSCAD]] |
||
|Version=0.14 |
|Version=0.14 |
||
|SeeAlso=[[Part_Primitives|Part Primitives]] |
|SeeAlso=[[Part_Primitives|Part Primitives]] |
||
Line 21: | Line 20: | ||
==Description== |
==Description== |
||
A [[Image:Part_RegularPolygon.svg|24px]] '''Part RegularPolygon''' 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 polygon lies on the XY plane with its center at the origin and one of its vertices on the X axis. |
|||
Creates a RegularPolygon geometric primitive. |
|||
[[Image:Part_RegularPolygon_Example.png|400px]] |
|||
==Usage== |
==Usage== |
||
See [[Part_Primitives#Usage|Part Primitives]]. |
|||
The RegularPolygon is available from the Create Primitives dialogue in the Part workbench. |
|||
# Switch to the [[Image:Workbench_Part.svg|24px]] [[Part_Workbench|Part Workbench]] |
|||
# The RegularPolygon command can be accessed several ways: |
|||
#* The Create Primitives dialogue via the [[Image:Part_Primitives.svg|24px]] [[Part_Primitives|Primitives]] icon located in the Part toolbar |
|||
#* Using the {{MenuCommand|Part → [[Part_Primitives|Create primitives]] → Regular Polygon}} |
|||
== |
== Example == |
||
[[Image:Part_RegularPolygon_Scripting_Example.png|thumb|Part RegularPolygon from the scripting example]] |
|||
*Polygon - the number of sides of the polygon which describes the cross section of the Part Prism |
|||
*Circumradius - the circumradius is the distance from the centre of the polygon to a vertex. |
|||
A Part RegularPolygon object created with the [[#Scripting|scripting example]] below is shown here. |
|||
== Properties == |
|||
See also: [[Property_editor|Property editor]]. |
|||
A Part RegularPolygon 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|Regular Polygon}} |
|||
* {{PropertyData|Polygon|IntegerConstraint}}: The number of sides of the polygon. The default is {{Value|6}}. |
|||
* {{PropertyData|Circumradius|Length}}: The radius of the circle that circumscribes the polygon, the distance from the center of the polygon to one of its vertices. The default is {{Value|2mm}}. |
|||
== Scripting == |
|||
See also: [https://freecad.github.io/SourceDoc/ Autogenerated API documentation], [[Part_scripting|Part scripting]] and [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]]. |
|||
A Part RegularPolygon can be created with the {{Incode|addObject()}} method of the document: |
|||
{{Code|code= |
|||
poly = FreeCAD.ActiveDocument.addObject("Part::RegularPolygon", "myPolygon") |
|||
}} |
|||
* Where {{Incode|"myPolygon"}} is the name for the object. |
|||
* The function returns the newly created object. |
|||
Example: |
|||
{{Code|code= |
|||
import FreeCAD as App |
|||
doc = App.activeDocument() |
|||
poly = doc.addObject("Part::RegularPolygon", "myPolygon") |
|||
poly.Polygon = 5 |
|||
poly.Circumradius = 8 |
|||
poly.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(60, 30, 15)) |
|||
doc.recompute() |
|||
}} |
|||
Line 46: | Line 89: | ||
}} |
}} |
||
{{ |
{{Part_Tools_navi{{#translation:}}}} |
||
{{Userdocnavi{{#translation:}}}} |
{{Userdocnavi{{#translation:}}}} |
||
{{clear}} |
Revision as of 10:31, 3 March 2022
Part RegularPolygon |
Menu location |
---|
Part → Create primitives → Regular polygon |
Workbenches |
Part, OpenSCAD |
Default shortcut |
None |
Introduced in version |
0.14 |
See also |
Part Primitives |
Description
A Part RegularPolygon is a parametric shape that can be created with the Part Primitives command. In the coordinate system defined by its DataPlacement property, the polygon lies on the XY plane with its center at the origin and one of its vertices on the X axis.
Usage
See Part Primitives.
Example
A Part RegularPolygon object created with the scripting example below is shown here.
Properties
See also: Property editor.
A Part RegularPolygon 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.
Regular Polygon
- DataPolygon (
IntegerConstraint
): The number of sides of the polygon. The default is6
. - DataCircumradius (
Length
): The radius of the circle that circumscribes the polygon, the distance from the center of the polygon to one of its vertices. The default is2mm
.
Scripting
See also: Autogenerated API documentation, Part scripting and FreeCAD Scripting Basics.
A Part RegularPolygon can be created with the addObject()
method of the document:
poly = FreeCAD.ActiveDocument.addObject("Part::RegularPolygon", "myPolygon")
- Where
"myPolygon"
is the name for the object. - The function returns the newly created object.
Example:
import FreeCAD as App
doc = App.activeDocument()
poly = doc.addObject("Part::RegularPolygon", "myPolygon")
poly.Polygon = 5
poly.Circumradius = 8
poly.Placement = App.Placement(App.Vector(1, 2, 3), App.Rotation(60, 30, 15))
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